Skip to content

Commit

Permalink
DOCS/man/input.rst: document the scalable commands
Browse files Browse the repository at this point in the history
  • Loading branch information
na-na-hi committed Nov 18, 2024
1 parent cf1fe9b commit 60b1483
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions DOCS/man/input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,9 @@ Playback Control
3rd parameter (essentially using a space instead of ``+``). The 3rd
parameter is still parsed, but is considered deprecated.

This is a scalable command. See the documentation of ``nonscalable`` input
command prefix in `Input Command Prefixes`_ for details.

``revert-seek [<flags>]``
Undoes the ``seek`` command, and some other commands that seek (but not
necessarily all of them). Calling this command once will jump to the
Expand Down Expand Up @@ -372,6 +375,9 @@ Property Manipulation
Add the given value to the property or option. On overflow or underflow,
clamp the property to the maximum. If ``<value>`` is omitted, assume ``1``.

This is a scalable command. See the documentation of ``nonscalable`` input
command prefix in `Input Command Prefixes`_ for details.

``multiply <name> <value>``
Similar to ``add``, but multiplies the property or option with the numeric
value.
Expand All @@ -386,6 +392,9 @@ Property Manipulation
Currently properties with continuous values are repeatable by default (like
``volume``), while discrete values are not (like ``osd-level``).

This is a scalable command. See the documentation of ``nonscalable`` input
command prefix in `Input Command Prefixes`_ for details.

``cycle-values [<"!reverse">] <property> <value1> [<value2> [...]]``
Cycle through a list of values. Each invocation of the command will set the
given property to the next value in the list. The command will use the
Expand Down Expand Up @@ -1302,6 +1311,9 @@ Scripting Commands
Future versions can add more arguments and more key state characters to
support more input peculiarities.

This is a scalable command. See the documentation of ``nonscalable`` input
command prefix in `Input Command Prefixes`_ for details.

``load-script <filename>``
Load a script, similar to the ``--script`` option. Whether this waits for
the script to finish initialization or not changed multiple times, and the
Expand Down

0 comments on commit 60b1483

Please sign in to comment.