summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2017-03-26 13:13:34 +0200
committerwm4 <wm4@nowhere>2017-03-26 13:13:34 +0200
commita94013f5857e4a335cc1da4cf3926a613f422b5c (patch)
tree9664622d61c814c175dfc57554c65591bd1fd1a1 /DOCS
parent439e2b43c33f48fe380d8c43c39836ec9a96064b (diff)
downloadmpv-a94013f5857e4a335cc1da4cf3926a613f422b5c.tar.bz2
mpv-a94013f5857e4a335cc1da4cf3926a613f422b5c.tar.xz
command: change and simplify filter toggle syntax
"@name:!" becomes simply "@name". This is actually slightly more complex to parse, but makes for a much simpler syntax and will be less weird to the user. Suggested by haasn. The old syntax is now rejected with an error. Also add some more explicit error checks, instead of e.g. allowing empty filter names and erroring only when it's not found.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/input.rst7
-rw-r--r--DOCS/man/vf.rst4
2 files changed, 8 insertions, 3 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 12193843ff..984b8db7d6 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -452,8 +452,9 @@ Input Commands that are Possibly Subject to Change
(If several filters are passed to the command, this is done for
each filter.)
- A special variant is combining this with labels, and using ``@name:!``
- as filter entry. This toggles the enable/disable flag.
+ A special variant is combining this with labels, and using ``@name``
+ without filter name and parameters as filter entry. This toggles the
+ enable/disable flag.
del
Remove the given filters from the video chain. Unlike in the other
@@ -497,7 +498,7 @@ Input Commands that are Possibly Subject to Change
name for this filter entry. The ``!`` before the filter name disables
the filter by default. Everything after this is the normal filter name
and the filter parameters.
- - Add ``a vf toggle @deband:!`` to ``input.conf``. This toggles the
+ - Add ``a vf toggle @deband`` to ``input.conf``. This toggles the
"disabled" flag for the filter identified with ``deband``.
``cycle-values ["!reverse"] <property> "<value1>" "<value2>" ...``
diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst
index a3f7ee6dab..e61b758af5 100644
--- a/DOCS/man/vf.rst
+++ b/DOCS/man/vf.rst
@@ -24,6 +24,10 @@ syntax is:
``["@"<label-name>":"] ["!"] <filter-name> [ "=" <filter-parameter-list> ]``
+ or for the special "toggle" syntax (see ``vf`` command):
+
+ ``"@"<label-name>``
+
and the ``filter-parameter-list``:
``<filter-parameter> | <filter-parameter> "," <filter-parameter-list>``