From 91a1b17104e6417cb2c77c838c85fabcff9e7d11 Mon Sep 17 00:00:00 2001 From: Timotej Lazar Date: Thu, 14 Jul 2016 20:04:59 +0200 Subject: Use - as command-name separator everywhere Old-style commands using _ as separator (e.g. show_progress) were still used in some places, including documentation and configuration files. This commit updates all such instances to the new style (show-progress) so that commands are easier to find in the manual. --- DOCS/man/input.rst | 6 +++--- DOCS/man/ipc.rst | 4 ++-- DOCS/man/mpv.rst | 2 +- DOCS/man/options.rst | 8 ++++---- DOCS/man/vo.rst | 2 +- DOCS/mplayer-changes.rst | 12 ++++++------ 6 files changed, 17 insertions(+), 17 deletions(-) (limited to 'DOCS') diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index cf524682a4..067e1c118d 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -640,7 +640,7 @@ Input Commands that are Possibly Subject to Change The argument is the name of the binding. It can optionally be prefixed with the name of the script, using ``/`` as - separator, e.g. ``script_binding scriptname/bindingname``. + separator, e.g. ``script-binding scriptname/bindingname``. For completeness, here is how this command works internally. The details could change any time. On any matching key event, ``script-message-to`` @@ -809,7 +809,7 @@ Input sections group a set of bindings, and enable or disable them at once. In ``input.conf``, each key binding is assigned to an input section, rather than actually having explicit text sections. -See also: ``enable_section`` and ``disable_section`` commands. +See also: ``enable-section`` and ``disable-section`` commands. Predefined bindings: @@ -1594,7 +1594,7 @@ Property list ``osd-width``, ``osd-height`` Last known OSD width (can be 0). This is needed if you want to use the - ``overlay_add`` command. It gives you the actual OSD size, which can be + ``overlay-add`` command. It gives you the actual OSD size, which can be different from the window size in some cases. ``osd-par`` diff --git a/DOCS/man/ipc.rst b/DOCS/man/ipc.rst index 7a0ed69723..80ba838a6e 100644 --- a/DOCS/man/ipc.rst +++ b/DOCS/man/ipc.rst @@ -41,7 +41,7 @@ It's also possible to send input.conf style text-only commands: :: - > echo 'show_text ${playback-time}' | socat - /tmp/mpvsocket + > echo 'show-text ${playback-time}' | socat - /tmp/mpvsocket But you won't get a reply over the socket. (This particular command shows the playback time on the player's OSD.) @@ -65,7 +65,7 @@ You can send commands from a command prompt: :: - echo show_text ${playback-time} >\\.\pipe\mpvsocket + echo show-text ${playback-time} >\\.\pipe\mpvsocket To be able to simultaneously read and write from the IPC pipe, like on Linux, it's necessary to write an external program that uses overlapped file I/O (or diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst index 736ef02c48..5a80319a78 100644 --- a/DOCS/man/mpv.rst +++ b/DOCS/man/mpv.rst @@ -946,7 +946,7 @@ For Windows-specifics, see `FILES ON WINDOWS`_ section. ``~/.config/mpv/watch_later/`` Contains temporary config files needed for resuming playback of files with the watch later feature. See for example the ``Q`` key binding, or the - ``quit_watch_later`` input command. + ``quit-watch-later`` input command. Each file is a small config file which is loaded if the corresponding media file is loaded. It contains the playback position and some (not necessarily diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index f9c32e5a9d..f8f3565ce5 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -404,7 +404,7 @@ Program Behavior ``--no-resume-playback`` Do not restore playback position from the ``watch_later`` configuration subdirectory (usually ``~/.config/mpv/watch_later/``). - See ``quit_watch_later`` input command. + See ``quit-watch-later`` input command. ``--profile=`` Use the given profile(s), ``--profile=help`` displays a list of the @@ -1283,7 +1283,7 @@ Audio or to set your own application name when using libmpv. ``--volume-restore-data=`` - Used internally for use by playback resume (e.g. with ``quit_watch_later``). + Used internally for use by playback resume (e.g. with ``quit-watch-later``). Restoring value has to be done carefully, because different AOs as well as softvol can have different value ranges, and we don't want to restore volume if setting the volume changes it system wide. The normal options @@ -2658,7 +2658,7 @@ OSD (default), then the playback time, duration, and some more information is shown. - This is also used for the ``show_progress`` command (by default mapped to + This is also used for the ``show-progress`` command (by default mapped to ``P``), or in some non-default cases when seeking. ``--osd-status-msg`` is a legacy equivalent (but with a minor difference). @@ -2666,7 +2666,7 @@ OSD ``--osd-status-msg=`` Show a custom string during playback instead of the standard status text. This overrides the status text used for ``--osd-level=3``, when using the - ``show_progress`` command (by default mapped to ``P``), or in some + ``show-progress`` command (by default mapped to ``P``), or in some non-default cases when seeking. Expands properties. See `Property Expansion`_. diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst index b80244ca6c..322b7fda59 100644 --- a/DOCS/man/vo.rst +++ b/DOCS/man/vo.rst @@ -1300,7 +1300,7 @@ Available video output drivers are: This also supports many of the suboptions the ``opengl`` VO has. Run ``mpv --vo=opengl-cb:help`` for a list. - This also supports the ``vo_cmdline`` command. + This also supports the ``vo-cmdline`` command. ``rpi`` (Raspberry Pi) Native video output on the Raspberry Pi using the MMAL API. diff --git a/DOCS/mplayer-changes.rst b/DOCS/mplayer-changes.rst index 06990219cc..0eb523660d 100644 --- a/DOCS/mplayer-changes.rst +++ b/DOCS/mplayer-changes.rst @@ -30,7 +30,7 @@ Player * Slave mode compatibility broken (see below). * Re-enable screensaver while the player is paused. * Allow resuming playback at a later point with ``Shift+q``, also see the - ``quit_watch_later`` input command. + ``quit-watch-later`` input command. * ``--keep-open`` option to stop the player from closing the window and exiting after playback ends. * A client API, that allows embedding **mpv** into applications @@ -312,11 +312,11 @@ input.conf and Slave Commands +--------------------------------+----------------------------------------+ | Old | New | +================================+========================================+ - | ``pt_step 1 [0|1]`` | ``playlist_next [weak|force]`` | + | ``pt_step 1 [0|1]`` | ``playlist-next [weak|force]`` | | | (translation layer cannot deal with | | | whitespace) | +--------------------------------+----------------------------------------+ - | ``pt_step -1 [0|1]`` | ``playlist_prev [weak|force] (same)`` | + | ``pt_step -1 [0|1]`` | ``playlist-prev [weak|force] (same)`` | +--------------------------------+----------------------------------------+ | ``switch_ratio []`` | ``set video-aspect `` | | | | @@ -331,7 +331,7 @@ input.conf and Slave Commands | `` `` | ``no-osd``: ``no-osd cycle `` | | | ```` | +--------------------------------+----------------------------------------+ - | ``osd_show_property_text`` | ``show_text `` | + | ``osd_show_property_text`` | ``show-text `` | | ```` | The property expansion format string | | | syntax slightly changed. | +--------------------------------+----------------------------------------+ @@ -340,9 +340,9 @@ input.conf and Slave Commands | | ``raw`` prefix to disable property | | | expansion. | +--------------------------------+----------------------------------------+ - | ``show_tracks`` | ``show_text ${track-list}`` | + | ``show_tracks`` | ``show-text ${track-list}`` | +--------------------------------+----------------------------------------+ - | ``show_chapters`` | ``show_text ${chapter-list}`` | + | ``show_chapters`` | ``show-text ${chapter-list}`` | +--------------------------------+----------------------------------------+ | ``af_switch``, ``af_add``, ... | ``af set|add|...`` | +--------------------------------+----------------------------------------+ -- cgit v1.2.3