summaryrefslogtreecommitdiffstats
path: root/DOCS/man/input.rst
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-09-18 00:49:55 +0200
committerwm4 <wm4@nowhere>2014-09-18 00:49:55 +0200
commit6c3d25e6f5f09a110ad0fffaeeea6a65ee5d228b (patch)
treee904c8cd346ccbd640412d1e9f628fff9197b526 /DOCS/man/input.rst
parenta522441bbe6817798ca58b93d7adb180a9598640 (diff)
downloadmpv-6c3d25e6f5f09a110ad0fffaeeea6a65ee5d228b.tar.bz2
mpv-6c3d25e6f5f09a110ad0fffaeeea6a65ee5d228b.tar.xz
command: allow using ASS tags on OSD messages
We don't allow this by default, because it would be silly if random external data (like filenames or file tags) could accidentally trigger them. Add a property that magically disables this ASS tag escaping. Note that malicious input could still disable ASS tag escaping by itself. This would be annoying but harmless.
Diffstat (limited to 'DOCS/man/input.rst')
-rw-r--r--DOCS/man/input.rst21
1 files changed, 19 insertions, 2 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 8afcd846ec..aae4d0a783 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1298,8 +1298,25 @@ Property list
``osd-sym-cc``
Inserts the current OSD symbol as opaque OSD control code (cc). This makes
- sense with the ``show_text`` command only. The control code is
- implementation specific and is useless for any other use.
+ sense only with the ``show_text`` command or options which set OSD messages.
+ The control code is implementation specific and is useless for anything else.
+
+``osd-ass-cc``
+ ``${osd-ass-cc/0}`` disables escaping ASS sequences of text in OSD,
+ ``${osd-ass-cc/1}`` enables it again. By default, ASS sequences are
+ escaped to avoid accidental formatting, and this property can disable
+ this behavior. Note that the properties return an opaque OSD control
+ code, which only makes sense for the ``show_text`` command or options
+ which set OSD messages.
+
+ .. admonition:: Example
+
+ --osd-status-msg='This is ${osd-ass-cc/0}{\\b1}bold text'
+
+ Any ASS override tags as understood by libass can be used.
+
+ Note that you need to escape the ``\`` character, because the string is
+ processed for C escape sequences before passing it to the OSD code.
``options/<name>`` (RW)
Read-only access to value of option ``--<name>``. Most options can be