diff options
Diffstat (limited to 'DOCS/man')
-rw-r--r-- | DOCS/man/lua.rst | 20 | ||||
-rw-r--r-- | DOCS/man/mpv.rst | 10 | ||||
-rw-r--r-- | DOCS/man/options.rst | 12 | ||||
-rw-r--r-- | DOCS/man/osc.rst | 4 |
4 files changed, 23 insertions, 23 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index 06450b112b..6d8695ab40 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -1,10 +1,10 @@ LUA SCRIPTING ============= -mpv can load Lua scripts. Scripts passed to the ``--lua`` option, or found in -the ``lua`` subdirectory of the mpv configuration directory (usually -``~/.config/mpv/lua/``) will be loaded on program start. mpv also appends the -``lua`` subdirectory to the end of Lua's path so you can import scripts from +mpv can load Lua scripts. Scripts passed to the ``--script`` option, or found in +the ``scripts`` subdirectory of the mpv configuration directory (usually +``~/.config/mpv/scripts/``) will be loaded on program start. mpv also appends the +``scripts`` subdirectory to the end of Lua's path so you can import scripts from there too. Since it's added to the end, don't name scripts you want to import the same as Lua libraries because they will be overshadowed by them. @@ -35,9 +35,9 @@ allow users implement features which are not going to be added to the mpv core. Mode of operation ----------------- -Your script will be loaded by the player at program start from the ``lua`` -configuration subdirectory, from a path specified with the ``--lua`` option, or -in some cases, internally (like ``--osc``). Each script runs in its own +Your script will be loaded by the player at program start from the ``scripts`` +configuration subdirectory, from a path specified with the ``--script`` option, +or in some cases, internally (like ``--osc``). Each script runs in its own thread. Your script is first run "as is", and once that is done, the event loop is entered. This event loop will dispatch events received by mpv and call your own event handlers which you have registered with ``mp.register_event``, or @@ -361,7 +361,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with ``mp.get_opt(key)`` - Return a setting from the ``--lua-opts`` option. It's up to the user and + Return a setting from the ``--script-opts`` option. It's up to the user and the script how this mechanism is used. Currently, all scripts can access this equally, so you should be careful about collisions. @@ -513,12 +513,12 @@ Example config:: optionC=no -Command-line options are read from the ``--lua-opts`` parameter. To avoid +Command-line options are read from the ``--script-opts`` parameter. To avoid collisions, all keys have to be prefixed with ``identifier-``. Example command-line:: - --lua-opts=myscript-optionA=TEST:myscript-optionB=0:myscript-optionC=yes + --script-opts=myscript-optionA=TEST:myscript-optionB=0:myscript-optionC=yes mp.utils options diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst index bbff3cc30b..0c8a0c0214 100644 --- a/DOCS/man/mpv.rst +++ b/DOCS/man/mpv.rst @@ -712,9 +712,9 @@ FILES ``~/.config/mpv/input.conf`` key bindings (see `INPUT.CONF`_ section) -``~/.config/mpv/lua/`` - All files in this directly are loaded as if they were passed to the - ``--lua`` option. They are loaded in alphabetical order, and sub-directories +``~/.config/mpv/scripts/`` + All files in this directory are loaded as if they were passed to the + ``--script`` option. They are loaded in alphabetical order, and sub-directories and files with no ``.lua`` extension are ignored. The ``--load-scripts=no`` option disables loading these files. @@ -738,8 +738,8 @@ locations are different: ``%APPDATA%/mpv/input.conf`` key bindings (see `INPUT.CONF`_ section) -``%APPDATA%/mpv/lua/`` - equivalent of ``~/.config/mpv/lua/`` on Unix. +``%APPDATA%/mpv/scripts/`` + equivalent of ``~/.config/mpv/scripts/`` on Unix. The environment variable ``$MPV_HOME`` completely overrides these, like on UNIX. diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 9b1ce379ab..7ae04a3b26 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -345,18 +345,18 @@ Program Behavior Specify configuration file to be parsed after the default ones. ``--load-scripts=<yes|no>`` - If set to ``no``, don't auto-load scripts from the ``lua`` configuration - subdirectory (usually ``~/.config/mpv/lua/``). + If set to ``no``, don't auto-load scripts from the ``scripts`` + configuration subdirectory (usually ``~/.config/mpv/scripts/``). (Default: ``yes``) -``--lua=<filename>`` +``--script=<filename>`` Load a Lua script. You can load multiple scripts by separating them with commas (``,``). -``--lua-opts=key1=value1,key2=value2,...`` - Set options for scripts. A Lua script can query an option by key. If an +``--script-opts=key1=value1,key2=value2,...`` + Set options for scripts. A script can query an option by key. If an option is used and what semantics the option value has depends entirely on - the loaded Lua scripts. Values not claimed by any scripts are ignored. + the loaded scripts. Values not claimed by any scripts are ignored. ``--merge-files`` Pretend that all files passed to mpv are concatenated into a single, big diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst index 9e2ead0126..d197715f29 100644 --- a/DOCS/man/osc.rst +++ b/DOCS/man/osc.rst @@ -138,7 +138,7 @@ Configuration The OSC offers limited configuration through a config file ``lua-settings/osc.conf`` placed in mpv's user dir and through the -``--lua-opts`` command-line option. Options provided through the command-line +``--script-opts`` command-line option. Options provided through the command-line will override those from the config file. Config Syntax @@ -161,7 +161,7 @@ To avoid collisions with other scripts, all options need to be prefixed with Example:: - --lua-opts=osc-optionA=value1,osc-optionB=value2 + --script-opts=osc-optionA=value1,osc-optionB=value2 Configurable Options |