summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2017-04-01 21:47:19 +0200
committerwm4 <wm4@nowhere>2017-04-01 21:47:19 +0200
commitdc7d71fc8e3b418f73a07ab46869850279587351 (patch)
tree47799f87336152c5a29a0be406cbdc8d74bcfd2d /DOCS
parent7bc193e955c1644fa6d8ad3ce488cfde5441205b (diff)
downloadmpv-dc7d71fc8e3b418f73a07ab46869850279587351.tar.bz2
mpv-dc7d71fc8e3b418f73a07ab46869850279587351.tar.xz
manpage, client API: add some clarifications when commands use OSD
The APIs that run commands in a more API-like manner disable OSD and string expansion by default.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/input.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index c6dc527044..6759226c6e 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -815,8 +815,10 @@ Input Command Prefixes
These prefixes are placed between key name and the actual command. Multiple
prefixes can be specified. They are separated by whitespace.
-``osd-auto`` (default)
- Use the default behavior for this command.
+``osd-auto``
+ Use the default behavior for this command. This is the default for
+ ``input.conf`` commands. Some libmpv/scripting/IPC APIs do not use this as
+ default, but use ``no-osd`` instead.
``no-osd``
Do not use any OSD for this command.
``osd-bar``
@@ -830,8 +832,10 @@ prefixes can be specified. They are separated by whitespace.
Combine osd-bar and osd-msg.
``raw``
Do not expand properties in string arguments. (Like ``"${property-name}"``.)
-``expand-properties`` (default)
+ This is the default for some libmpv/scripting/IPC APIs.
+``expand-properties``
All string arguments are expanded as described in `Property Expansion`_.
+ This is the default for ``input.conf`` commands.
``repeatable``
For some commands, keeping a key pressed doesn't run the command repeatedly.
This prefix forces enabling key repeat in any case.