From ce513dedd8b61509d58aa3d76551e1aad36573f2 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Thu, 11 Jun 2015 21:20:39 +0200
Subject: lua: export end-file event fields

---
 DOCS/man/lua.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'DOCS/man/lua.rst')

diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst
index db4957addc..4d3fb7c3d8 100644
--- a/DOCS/man/lua.rst
+++ b/DOCS/man/lua.rst
@@ -690,6 +690,23 @@ List of events
     Happens after a file was unloaded. Typically, the player will load the
     next file right away, or quit if this was the last file.
 
+    The event has the ``reason`` field, which takes one of these values:
+
+    ``eof``
+        The file has ended. This can (but doesn't have to) include
+        incomplete files or broken network connections under
+        circumstances.
+
+    ``stop``
+        Playback was ended by a command.
+
+    ``quit``
+        Playback was ended by sending the quit command.
+
+    ``error``
+        An error happened. In this case, an ``error`` field is present with
+        the error string.
+
 ``file-loaded``
     Happens after a file was loaded and begins playback.
 
-- 
cgit v1.2.3