diff --git a/DOCS/man/en/changes.rst b/DOCS/man/en/changes.rst index 5b1c3ea4a6..402bdbd336 100644 --- a/DOCS/man/en/changes.rst +++ b/DOCS/man/en/changes.rst @@ -84,7 +84,7 @@ Command line switches ``-no-opt``, or better ``--no-opt``. * Per-file options are not the default anymore. You can explicitly specify file local options. See ``Usage`` section. -* Table of renamed switches: +* Table of renamed/replaced switches: =================================== =================================== Old New @@ -92,20 +92,53 @@ Command line switches -nosound --no-audio -use-filename-title --title="${filename}" -loop 0 --loop=inf + -hardframedrop --framedrop=hard + -osdlevel --osd-level + -delay --audio-delay + -subdelay --sub-delay + -subpos --sub-pos + -forcedsubsonly --sub-forced-only =================================== =================================== input.conf and slave commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* Table of renamed slave commands: +* Table of renamed input commands: - =================================== =================================== - Old New - =================================== =================================== - pt_step 1 b playlist_next b - pt_step -1 b playlist_prev b - pt_clear playlist_clear - =================================== =================================== + This lists only commands that are not always gracefully handled by the + internal legacy translation layer. If an input.conf contains any legacy + commands, they will be displayed with ``-v`` when it is loaded, and show + and the replacement commands. + + Properties containing ``_`` to separate words use ``-`` instead. + + +--------------------------------+----------------------------------------+ + | Old | New | + +================================+========================================+ + | pt_step 1 [0|1] | playlist_next [weak|force] | + | | (translation layer can't deal with | + | | whitespace) | + +--------------------------------+----------------------------------------+ + | pt_step -1 [0|1] | playlist_prev [weak|force] (same) | + +--------------------------------+----------------------------------------+ + | switch_ratio [] | set aspect | + | | set aspect 0 (to reset aspect) | + +--------------------------------+----------------------------------------+ + | step_property_osd | cycle (wraps), | + | | add (clamps). | + | | parameter unsupported. Use | + | | a negative step instead. | + +--------------------------------+----------------------------------------+ + | step_property | Prefix cycle or add with no-osd: | + | | no-osd cycle | + +--------------------------------+----------------------------------------+ + | osd_show_property_text | show_text | + | | The property expansion format string | + | | syntax slightly changed. | + +--------------------------------+----------------------------------------+ + | osd_show_text | Now does the same as | + | | osd_show_property_text. | + +--------------------------------+----------------------------------------+ Other ~~~~~ diff --git a/DOCS/man/en/input.rst b/DOCS/man/en/input.rst new file mode 100644 index 0000000000..58565f0267 --- /dev/null +++ b/DOCS/man/en/input.rst @@ -0,0 +1,308 @@ +.. _input: + +INPUT.CONF +========== + +The input.conf file consists of a list of key bindings, for example: + +| s screenshot # take a screenshot with the s key + +Each line maps a key to an input command. Keys are specified with their literal +value (upper case if combined with ``Shift``), or a name for special keys. For +example, ``a`` maps to the ``a`` key without shift, and ``A`` maps to ``a`` +with shift. + +A list of special keys can be obtained with + +| **mplayer** --input=keylist + +In general, keys can be combined with ``Shift``, ``Ctrl`` and ``Alt``: + +| ctrl+q quit + +General input command syntax +---------------------------- + +`[Shift+][Ctrl+][Alt+][Meta+] [] ()*` + +Newlines always start a new binding. ``#`` starts a comment (outside of quoted +string arguments). To bind commands to the ``#`` key, ``SHARP`` can be used. + + is either the literal character the key produces (ASCII or unicode +character), or a symbol name. + +Arguments are separated by whitespace. This applies even to string arguments. +For this reason, string arguments should be quoted with ``"``. Inside quotes, +C style escaping can be used. + +Optional arguments can be skipped with ``-``. + +List of input commands +---------------------- + +ignore + Use this to "block" keys that should be unbound, and do nothing. Useful for + disabling default bindings, without disabling all bindings with + ``--input=default-bindings=no``. + +seek [relative|absolute|absolute-percent] [default-precise|exact|keyframes] + Change the playback position. By default, seeks by a relative amount of + seconds. + + The second argument sets the seek mode: + + relative (default) + Seek relative to current position (a negative value seeks backwards). + absolute + Seek to a given time. + absolute-percent + Seek to agiven percent position. + + The third argument defines how exact the seek is: + + default-precise (default) + Follow the default behavior as set by ``--hr-seek``, which by default + does imprecise seeks (like ``keyframes``). + exact + Always do exact/hr/precise seeks (slow). + keyframes + Always restart playback at keyframe boundaries (fast). + +frame_step + Basically seek forward by one frame. Actually this plays one frame, then + pauses again. + +set "" + Set the given property to the given value. + +add [] + Add the given value to the property. On overflow or underflow, clamp the + property to the maximum. If is omitted, assume ``1``. + +cycle [up|down] + Cycle the given property. ``up`` and ``down`` set the cycle direction. On + overflow, set the property back to the minimum, on underflow set it to the + maximum. If ``up`` or ``down`` is omitted, assume ``up``. + +speed_mult + Multiply the ``speed`` property by the given value. + +screenshot [single|each-frame] [video|window] + Take a screenshot. + + First argument: + + (default) + Take a single screenshot. + + Take a screenshot each frame. Issue this command again to stop taking + screenshots. + + Second argument: + +