summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-04-12 20:44:13 +0200
committerwm4 <wm4@nowhere>2014-04-12 20:44:13 +0200
commit76961843c3b9088a06c3ff07f082306d1e2fc247 (patch)
treeccae8f1dc59265f2f440320f2c6f32b5dbf08ed2 /DOCS/man
parentf3c0897b3ff0389043ef8cba0f4e6ffada3b2e9f (diff)
downloadmpv-76961843c3b9088a06c3ff07f082306d1e2fc247.tar.bz2
mpv-76961843c3b9088a06c3ff07f082306d1e2fc247.tar.xz
manpage: lua: separate "advanced" functions into a separate section
This will be less confusing.
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/en/lua.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst
index c4e1614999..f29df4a6d9 100644
--- a/DOCS/man/en/lua.rst
+++ b/DOCS/man/en/lua.rst
@@ -313,6 +313,16 @@ The ``mp`` module is preloaded, although it can be loaded manually with
The script ``/path/to/fooscript.lua`` becomes ``lua/fooscript``.
+``mp.osd_message(text [,duration])``
+ Show an OSD message on the screen. ``duration`` is in seconds, and is
+ optional (uses ``--osd-duration`` by default).
+
+Advanced mp functions
+---------------------
+
+These also live in the ``mp`` module, but are documented separately as they
+are useful only in special situations.
+
``mp.suspend()``
Suspend the mpv main loop. There is a long-winded explanation of this in
the C API function ``mpv_suspend()``. In short, this prevents the player
@@ -378,10 +388,6 @@ The ``mp`` module is preloaded, although it can be loaded manually with
Undo a previous registration with ``mp.register_script_message``. Does
nothing if the ``name`` wasn't registered.
-``mp.osd_message(text [,duration])``
- Show an OSD message on the screen. ``duration`` is in seconds, and is
- optional (uses ``--osd-duration`` by default).
-
mp.msg functions
----------------