Skip to content

Commit

Permalink
DOCS/man: refer to "mp.options functions" for script config docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
na-na-hi authored and sfan5 committed Apr 21, 2024
1 parent b364e4a commit 5318522
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 18 deletions.
2 changes: 1 addition & 1 deletion DOCS/man/console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Configuration

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
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
documentation.
Expand Down
19 changes: 3 additions & 16 deletions DOCS/man/osc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,22 +130,9 @@ del Cycles visibility between never / auto (mouse-move) / always
Configuration
-------------

The OSC offers limited configuration through a config file
``script-opts/osc.conf`` placed in mpv's user dir and through the
``--script-opts`` command-line option. Options provided through the command-line
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.
This script can be customized through a config file ``script-opts/osc.conf``
placed in mpv's user directory and through the ``--script-opts`` command-line
option. The configuration syntax is described in `mp.options functions`_.

Command-line Syntax
~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion DOCS/man/stats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Configuration

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
option. The configuration syntax is described in `ON SCREEN CONTROLLER`_.
option. The configuration syntax is described in `mp.options functions`_.

Configurable Options
~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 5318522

Please sign in to comment.