From b6b8bffd2d4438e007da4cbf9b50e9305016bd73 Mon Sep 17 00:00:00 2001 From: Alexander Preisinger Date: Thu, 31 Jul 2014 16:32:37 +0200 Subject: manpage: add sections and order by usage Split the options into the following sections: * Playback Control * Program Behaviour * Video * Audio * Subtitles * Window * Disc Devices * Equalizer * Demuxer * Input * OSD * Screenshot * Software Scaler * Terminal * TV * Cache * Network * DVB * PVR * Miscellaneous Most options are sorted by usefullness and how often they're used or how important they are. This makes finding the right options easier and adds some sort of structure. --- DOCS/man/options.rst | 4113 ++++++++++++++++++++++++++------------------------ 1 file changed, 2123 insertions(+), 1990 deletions(-) (limited to 'DOCS') diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 17257844b5..eaab0c48e7 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -1,82 +1,8 @@ OPTIONS ======= -``--ad=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>`` - Specify a priority list of audio decoders to be used, according to their - family and decoder name. Entries like ``family:*`` prioritize all decoders - of the given family. When determining which decoder to use, the first - decoder that matches the audio format is selected. If that is unavailable, - the next decoder is used. Finally, it tries all other decoders that are not - explicitly selected or rejected by the option. - - ``-`` at the end of the list suppresses fallback on other available - decoders not on the ``--ad`` list. ``+`` in front of an entry forces the - decoder. Both of these should not normally be used, because they break - normal decoder auto-selection! - - ``-`` in front of an entry disables selection of the decoder. - - .. admonition:: Examples - - ``--ad=lavc:mp3float`` - Prefer the FFmpeg/Libav ``mp3float`` decoder over all other mp3 - decoders. - - ``--ad=spdif:ac3,lavc:*`` - Always prefer spdif AC3 over FFmpeg/Libav over anything else. - - ``--ad=help`` - List all available decoders. - -``--ad-lavc-ac3drc=`` - Select the Dynamic Range Compression level for AC-3 audio streams. - ```` is a float value ranging from 0 to 1, where 0 means no - compression and 1 (which is the default) means full compression (make loud - passages more silent and vice versa). Values up to 2 are also accepted, but - are purely experimental. This option only shows an effect if the AC-3 stream - contains the required range compression information. - -``--ad-lavc-downmix=`` - Whether to request audio channel downmixing from the decoder (default: yes). - Some decoders, like AC-3, AAC and DTS, can remix audio on decoding. The - requested number of output channels is set with the ``--audio-channels`` option. - Useful for playing surround audio on a stereo system. - -``--ad-lavc-threads=<0-16>`` - Number of threads to use for decoding. Whether threading is actually - supported depends on codec. As of this writing, it's supported for some - lossless codecs only. 0 means autodetect number of cores on the - machine and use that, up to the maximum of 16 (default: 1). - -``--ad-lavc-o==[,=[,...]]`` - Pass AVOptions to libavcodec decoder. Note, a patch to make the o= - unneeded and pass all unknown options through the AVOption system is - welcome. A full list of AVOptions can be found in the FFmpeg manual. - -``--ad-spdif-dtshd=``, ``--dtshd``, ``--no-dtshd`` - When using DTS passthrough, output any DTS-HD track as-is. - With ``ad-spdif-dtshd=no`` (the default), only the DTS Core parts will be - output. - - DTS-HD tracks can be sent over HDMI but not over the original - coax/toslink S/PDIF system. - - Some receivers don't accept DTS core-only when ``--ad-spdif-dtshd=yes`` is - used, even though they accept DTS-HD. - - ``--dtshd`` and ``--no-dtshd`` are deprecated aliases. - -``--af=`` - Specify a list of audio filters to apply to the audio stream. See - `AUDIO FILTERS`_ for details and descriptions of the available filters. - The option variants ``--af-add``, ``--af-pre``, ``--af-del`` and - ``--af-clr`` exist to modify a previously specified list, but you - should not need these for typical use. - -``--aid=`` - Select audio track. ``auto`` selects the default, ``no`` disables audio. - See also ``--alang``. mpv normally prints available audio tracks on the - terminal when starting playback of a file. +Track Selection +--------------- ``--alang=`` Specify a priority list of audio languages to use. Different container @@ -92,1222 +18,1354 @@ OPTIONS ``mpv --alang=jpn example.mkv`` Plays a Matroska file in Japanese. -``--ao=`` - Specify a priority list of audio output drivers to be used. For - interactive use one would normally specify a single one to use, but in - configuration files specifying a list of fallbacks may make sense. See - `AUDIO OUTPUT DRIVERS`_ for details and descriptions of available drivers. - -``--sub-ass``, ``--no-sub-ass`` - Render ASS subtitles natively (enabled by default). +``--slang=`` + Specify a priority list of subtitle languages to use. Different container + formats employ different language codes. DVDs use ISO 639-1 two letter + language codes, Matroska uses ISO 639-2 three letter language codes while + OGM uses a free-form identifier. See also ``--sid``. - If ``--no-sub-ass`` is specified, all tags and style declarations are - stripped and ignored on display. The subtitle renderer uses the font style - as specified by the ``--sub-text-`` options instead. + .. admonition:: Examples - .. note:: + - ``mpv dvd://1 --slang=hu,en`` chooses the Hungarian subtitle track on + a DVD and falls back on English if Hungarian is not available. + - ``mpv --slang=jpn example.mkv`` plays a Matroska file with Japanese + subtitles. - Using ``--no-sub-ass`` may lead to incorrect or completely broken - rendering of ASS/SSA subtitles. It can sometimes be useful to forcibly - override the styling of ASS subtitles, but should be avoided in general. +``--aid=`` + Select audio track. ``auto`` selects the default, ``no`` disables audio. + See also ``--alang``. mpv normally prints available audio tracks on the + terminal when starting playback of a file. - .. note:: +``--sid=`` + Display the subtitle stream specified by ````. ``auto`` selects + the default, ``no`` disables subtitles. - Try using ``--ass-style-override=force`` instead. + See also ``--slang``, ``--no-sub``. -``--ass-force-style=<[Style.]Param=Value[,...]>`` - Override some style or script info parameters. +``--vid=`` + Select video channel. ``auto`` selects the default, ``no`` disables video. - .. admonition:: Examples +``--edition=`` + (Matroska files only) + Specify the edition (set of chapters) to use, where 0 is the first. If set + to ``auto`` (the default), mpv will choose the first edition declared as a + default, or if there is no default, the first edition defined. - - ``--ass-force-style=FontName=Arial,Default.Bold=1`` - - ``--ass-force-style=PlayResY=768`` - .. note:: +Playback Control +---------------- - Using this option may lead to incorrect subtitle rendering. +``--start=`` + Seek to given time position. -``--ass-hinting=none|light|normal|native`` - Set font hinting type. can be: + The general format for absolute times is ``[[hh:]mm:]ss[.ms]``. If the time + is given with a prefix of ``+`` or ``-``, the seek is relative from the start + or end of the file. - :none: no hinting (default) - :light: FreeType autohinter, light mode - :normal: FreeType autohinter, normal mode - :native: font native hinter + ``pp%`` seeks to percent position pp (0-100). - .. admonition:: Warning + ``#c`` seeks to chapter number c. (Chapters start from 1.) - Enabling hinting can lead to mispositioned text (in situations it's - supposed to match up with video background), or reduce the smoothness - of animations with some badly authored ASS scripts. It is recommended - to not use this option, unless really needed. + .. admonition:: Examples -``--ass-line-spacing=`` - Set line spacing value for SSA/ASS renderer. + ``--start=+56``, ``--start=+00:56`` + Seeks to the start time + 56 seconds. + ``--start=-56``, ``--start=-00:56`` + Seeks to the end time - 56 seconds. + ``--start=01:10:00`` + Seeks to 1 hour 10 min. + ``--start=50%`` + Seeks to the middle of the file. + ``--start=30 --end=40`` + Seeks to 30 seconds, plays 10 seconds, and exits. + ``--start=-3:20 --length=10`` + Seeks to 3 minutes and 20 seconds before the end of the file, plays + 10 seconds, and exits. + ``--start='#2' --end='#4'`` + Plays chapters 2 and 3, and exits. -``--ass-shaper=simple|complex`` - Set the text layout engine used by libass. +``--end=