diff options
| author | Guido Cella <guido@guidocella.xyz> | 2021-07-23 20:00:02 +0200 |
|---|---|---|
| committer | avih <avih@users.noreply.github.com> | 2021-07-27 20:35:07 +0300 |
| commit | ecd06a5d01cef2e066b6822ae9186ea1f5a4f857 (patch) | |
| tree | e3713070355e4cec427669fd9b9f745e8b0efb2a /DOCS | |
| parent | 6fe4fc4593dd5126a208fda83bbff97c7add446b (diff) | |
| download | mpv-ecd06a5d01cef2e066b6822ae9186ea1f5a4f857.tar.bz2 mpv-ecd06a5d01cef2e066b6822ae9186ea1f5a4f857.tar.xz | |
manpage: explain when properties are expanded
Diffstat (limited to 'DOCS')
| -rw-r--r-- | DOCS/man/input.rst | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index eaca8bae99..c627c006b6 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -183,7 +183,8 @@ surrogate pair escapes, should be a safe subset that can be used. Note that argument parsing and property expansion happen at different stages. First, arguments are determined as described above, and then, where applicable, properties are expanded - regardless of argument quoting. However, expansion -can still be prevented with ``$>``. See `Property Expansion`_. +can still be prevented with the ``raw`` prefix or ``$>``. See `Input Command +Prefixes`_ and `Property Expansion`_. Commands specified as arrays ---------------------------- @@ -206,6 +207,9 @@ quotes and escaping. The array command APIs mentioned above pass strings directly to the argument parsers, or can sidestep them by the ability to pass non-string values. +Property expansion is disabled by default for these APIs. This can be changed +with the ``expand-properties`` prefix. See `Input Command Prefixes`_. + Sometimes commands have string arguments, that in turn are actually parsed by other components (e.g. filter strings with ``vf add``) - in these cases, you you would have to double-escape in input.conf, but not with the array APIs. @@ -232,6 +236,9 @@ to use APIs that pass arguments as arrays. Named arguments are not supported in the "flat" input.conf syntax, which means you cannot use them for key bindings in input.conf at all. +Property expansion is disabled by default for these APIs. This can be changed +with the ``expand-properties`` prefix. See `Input Command Prefixes`_. + List of Input Commands ---------------------- @@ -3450,8 +3457,11 @@ command is an exception and not a general rule.) ``i show-text "Filename: ${filename}"`` shows the filename of the current file when pressing the ``i`` key -Within ``input.conf``, property expansion can be inhibited by putting the -``raw`` prefix in front of commands. +Whether property expansion is enabled by default depends on which API is used +(see `Flat command syntax`_, `Commands specified as arrays`_ and `Named +arguments`_), but it can always be enabled with the ``expand-properties`` +prefix or disabled with the ``raw`` prefix, as described in `Input Command +Prefixes`_. The following expansions are supported: |