summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en/options.rst
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2013-06-08 18:04:36 +0200
committerwm4 <wm4@nowhere>2013-06-08 18:09:58 +0200
commit4af59abbb416a365a98efca8875c0f0c1b0c872f (patch)
tree06190ded619bda96bc692cc06a6b5b81e6d3060b /DOCS/man/en/options.rst
parent667c8352f3b0a8dcdaadd2aac6d4588a376e5e52 (diff)
downloadmpv-4af59abbb416a365a98efca8875c0f0c1b0c872f.tar.bz2
mpv-4af59abbb416a365a98efca8875c0f0c1b0c872f.tar.xz
manpage: improve documentation of property expansion
Diffstat (limited to 'DOCS/man/en/options.rst')
-rw-r--r--DOCS/man/en/options.rst37
1 files changed, 5 insertions, 32 deletions
diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst
index 78678267cb..bc78c2aeaf 100644
--- a/DOCS/man/en/options.rst
+++ b/DOCS/man/en/options.rst
@@ -1440,7 +1440,7 @@
Show a custom string during playback instead of the standard status text.
This overrides the status text used for ``--osd-level=3``, when using the
``show_progress`` command (by default mapped to ``P``), or in some
- non-default cases when seeking. Expands properties. See ``--playing-msg``.
+ non-default cases when seeking. Expands properties. See property_expansion_.
--overlapsub
Allows the next subtitle to be displayed while the current one is still
@@ -1472,38 +1472,11 @@
properties, e.g. ``--playing-msg=file: ${filename}`` will print the string
``file:`` followed by a space and the currently played filename.
- The following expansions are supported:
-
- \${NAME}
- Expands to the value of the property ``NAME``. If ``NAME`` starts with
- ``=``, use the raw value of the property. If retrieving the property
- fails, expand to an error string. (Use ``${NAME:}`` with a trailing
- ``:`` to expand to an empty string instead.)
- \${NAME:STR}
- Expands to the value of the property ``NAME``, or ``STR`` if the
- property can't be retrieved. ``STR`` is expanded recursively.
- \${!NAME:STR}
- Expands to ``STR`` (recursively) if the property ``NAME`` can't be
- retrieved.
- \${?NAME:STR}
- Expands to ``STR`` (recursively) if the property ``NAME`` is available.
- \$\$
- Expands to ``$``.
- \$}
- Expands to ``}``. (To produce this character inside recursive
- expansion.)
- \$>
- Disable property expansion and special handling of ``$`` for the rest
- of the string.
-
- This option also parses C-style escapes. Example:
-
- - ``\n`` becomes a newline character
- - ``\\`` expands to ``\``
+ See property_expansion_.
--status-msg=<string>
Print out a custom string during playback instead of the standard status
- line. Expands properties. See ``--playing-msg``.
+ line. Expands properties. See property_expansion_.
--stream-capture=<filename>
Allows capturing the primary stream (not additional audio tracks or other
@@ -2142,8 +2115,8 @@
the line used for the OSD and clear it (default: ``^[[A\r^[[K``).
--title=<string>
- Set the window title. Properties are expanded on playback start
- (see ``--playing-msg``).
+ Set the window title. Properties are expanded on playback start.
+ (See property_expansion_.)
--tv=<option1:option2:...>
This option tunes various properties of the TV capture module. For