RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2025-04-07 01:53:06 +00:00
Code Issues Releases Wiki Activity

DOCS/mpv: update mpv.conf's documentation

Browse Source
This commit is contained in:
Guido Cella 2023-10-06 09:05:59 +02:00 committed by Dudemanguy
parent eecba5131a
commit 7798881360
1 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
DOCS/man/mpv.rst
View File

@ -629,30 +629,34 @@ user-specific one is ``~/.config/mpv/mpv.conf``. For details and platform
specifics (in particular Windows paths) see the `FILES`_ section. specifics (in particular Windows paths) see the `FILES`_ section.
User-specific options override system-wide options and options given on the User-specific options override system-wide options and options given on the
command line override either. The syntax of the configuration files is command line override both. The syntax of the configuration files is
``option=value``. Everything after a *#* is considered a comment. Options ``option=value``. Everything after a *#* is considered a comment. Options that
that work without values can be enabled by setting them to *yes* and disabled by work without values can be enabled by setting them to *yes* and disabled by
setting them to *no*. Even suboptions can be specified in this way. setting them to *no*, and if the value is omitted, *yes* is implied. Even
suboptions can be specified in this way.
.. admonition:: Example configuration file .. admonition:: Example configuration file
:: ::
# Use GPU-accelerated video output by default. # Don't allow new windows to be larger than the screen.
vo=gpu autofit-larger=100%x100%
# Use quotes for text that can contain spaces: # Enable hardware decoding if available, =yes is implied.
term-status-msg="Time: ${time-pos}" hwdec
# Spaces don't have to be escaped.
osd-playing-msg=File: ${filename}
Escaping spaces and special characters Escaping special characters
-------------------------------------- --------------------------------------
This is done like with command line options. The shell is not involved here, This is done like with command line options. A config entry can be quoted with
but option values still need to be quoted as a whole if it contains certain ``"``, ``'``, as well as with the fixed-length syntax (``%n%``) mentioned
characters like spaces. A config entry can be quoted with ``"``, before. This is like passing the exact contents of the quoted string as a
as well as with the fixed-length syntax (``%n%``) mentioned before. This is like command line option. C-style escapes are currently _not_ interpreted on this
passing the exact contents of the quoted string as command line option. C-style level, although some options do this manually (this is a mess and should
escapes are currently _not_ interpreted on this level, although some options do probably be changed at some point). The shell is not involved here, so option
this manually. (This is a mess and should probably be changed at some point.) values only need to be quoted to escape ``#`` and ``\``, ``"``, ``'`` or ``%``
at the beginning of the value, and leading and trailing whitespace.
Putting Command Line Options into the Configuration File Putting Command Line Options into the Configuration File
-------------------------------------------------------- --------------------------------------------------------
@ -666,7 +670,7 @@ Option Configuration file entry
``--flag`` ``flag`` ``--flag`` ``flag``
``-opt val`` ``opt=val`` ``-opt val`` ``opt=val``
``--opt=val`` ``opt=val`` ``--opt=val`` ``opt=val``
``-opt "has spaces"`` ``opt="has spaces"`` ``-opt "has spaces"`` ``opt=has spaces``
======================= ======================== ======================= ========================
File-specific Configuration Files File-specific Configuration Files