RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

DOCS/man: refer to "mp.options functions" for script config docs 

Currently they refer to the OSC documentation. However,
the "mp.options functions" already documents that, is more detailed,
and does not contain false statements like "there may be no spaces around
the ``=`` or anywhere else" (the primitive parser does not care about
them, so starting a string option value with spaces is perfectly fine).

Change them to refer to "mp.options functions" and remove the redundant
section in the OSC documentation.
This commit is contained in:
nanahi 2024-04-20 10:16:53 -04:00 committed by sfan5
parent b364e4a65c
commit 5318522b50
3 changed files with 5 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
DOCS/man/console.rst
View File

@ -123,7 +123,7 @@ Configuration
This script can be customized through a config file ``script-opts/console.conf`` This script can be customized through a config file ``script-opts/console.conf``
placed in mpv's user directory and through the ``--script-opts`` command-line placed in mpv's user directory and through the ``--script-opts`` command-line
option. The configuration syntax is described in `ON SCREEN CONTROLLER`_. option. The configuration syntax is described in `mp.options functions`_.
Key bindings can be changed in a standard way, see for example stats.lua Key bindings can be changed in a standard way, see for example stats.lua
documentation. documentation.

19
DOCS/man/osc.rst
View File

@ -130,22 +130,9 @@ del Cycles visibility between never / auto (mouse-move) / always
Configuration Configuration
------------- -------------
The OSC offers limited configuration through a config file This script can be customized through a config file ``script-opts/osc.conf``
``script-opts/osc.conf`` placed in mpv's user dir and through the placed in mpv's user directory and through the ``--script-opts`` command-line
``--script-opts`` command-line option. Options provided through the command-line option. The configuration syntax is described in `mp.options functions`_.
will override those from the config file.
Config Syntax
~~~~~~~~~~~~~
The config file must exactly follow the following syntax::
# this is a comment
optionA=value1
optionB=value2
``#`` can only be used at the beginning of a line and there may be no
spaces around the ``=`` or anywhere else.
Command-line Syntax Command-line Syntax
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~

2
DOCS/man/stats.rst
View File

@ -43,7 +43,7 @@ Configuration
This script can be customized through a config file ``script-opts/stats.conf`` This script can be customized through a config file ``script-opts/stats.conf``
placed in mpv's user directory and through the ``--script-opts`` command-line placed in mpv's user directory and through the ``--script-opts`` command-line
option. The configuration syntax is described in `ON SCREEN CONTROLLER`_. option. The configuration syntax is described in `mp.options functions`_.
Configurable Options Configurable Options
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~