diff options
Diffstat (limited to 'DOCS/man/options.rst')
| -rw-r--r-- | DOCS/man/options.rst | 105 |
1 files changed, 90 insertions, 15 deletions
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index bf1d55a294..55c2f45530 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -5,11 +5,11 @@ Track Selection --------------- ``--alang=<languagecode[,languagecode,...]>`` - Specify a priority list of audio languages to use, as IETF language tags. - Equivalent ISO 639-1 two-letter and ISO 639-2 three-letter codes are treated the same. - The first tag in the list whose language matches a track in the file will be used. - A track that matches more subtags will be preferred over one that matches fewer, - with preference given to earlier subtags over later ones. See also ``--aid``. + Specify a prioritized list of audio languages to use, as IETF language tags. + Equivalent ISO 639-1 two-letter and ISO 639-2 three-letter codes are treated + the same. The first tag in the list that matches track's language in the file + will be used. A track that matches more subtags will be preferred over one + that matches fewer. See also ``--aid``. This is a string list option. See `List Options`_ for details. @@ -146,7 +146,7 @@ Track Selection ``--subs-match-os-language=<yes|no>`` When autoselecting a subtitle track, select the track that matches the language of your OS if the audio stream is in a different language if suitable (default track or a forced track - under the right conditions). Note that if ``-slang`` is set, this will be completely ignored + under the right conditions). Note that if ``--slang`` is set, this will be completely ignored (default: yes). ``--subs-fallback=<yes|default|no>`` @@ -1023,6 +1023,10 @@ Program Behavior `Conditional auto profiles`_ for details. ``auto`` will load the script, but immediately unload it if there are no conditional profiles. +``--load-select=<yes|no>`` + Enable the builtin script that lets you select from lists of items (default: + yes). By default, its keybindings start with the ``g`` key. + ``--player-operation-mode=<cplayer|pseudo-gui>`` For enabling "pseudo GUI mode", which means that the defaults for some options are changed. This option should not normally be used directly, but @@ -2387,7 +2391,8 @@ Subtitles Whether to scale subtitles with the window size (default: yes). If this is disabled, changing the window size won't change the subtitle font size. - Like ``--sub-scale``, this can break ASS subtitles. + Affects plain text subtitles only (or ASS if ``--sub-ass-override`` is set + high enough). ``--sub-scale-with-window=<yes|no>`` Make the subtitle font size relative to the window, instead of the video. @@ -2496,7 +2501,7 @@ Subtitles Using this option may lead to incorrect subtitle rendering. -``--sub-ass-override=<yes|no|force|scale|strip>`` +``--sub-ass-override=<no|yes|scale|force|strip>`` Control whether user style overrides should be applied. Note that all of these overrides try to be somewhat smart about figuring out whether or not a subtitle is considered a "sign". @@ -2505,17 +2510,17 @@ Subtitles overrides. :yes: Apply all the ``--sub-ass-*`` style override options. Changing the default for any of these options can lead to incorrect subtitle - rendering (default). + rendering. + :scale: Like ``yes``, but also apply ``--sub-scale`` (default). :force: Like ``yes``, but also force all ``--sub-*`` options. Can break rendering easily. - :scale: Like ``yes``, but also apply ``--sub-scale``. :strip: Radically strip all ASS tags and styles from the subtitle. This is equivalent to the old ``--no-ass`` / ``--no-sub-ass`` options. This also controls some bitmap subtitle overrides, as well as HTML tags in formats like SRT, despite the name of the option. -``--secondary-sub-ass-override=<yes|no|force|scale|strip>`` +``--secondary-sub-ass-override=<no|yes|scale|force|strip>`` Control whether user secondary substyle overrides should be applied. This works exactly like ``--sub-ass-override``. @@ -4101,6 +4106,17 @@ Input Whether this applies depends on the VO backend and how it handles keyboard input. Does not apply to terminal input. +``--native-touch=<yes|no>`` + (Windows only) + For platforms which send emulated mouse inputs for touch-unaware clients, + such as Windows, use system native touch events, instead of receiving them + as emulated mouse events (default: no). This is required for multi-touch + support for these platforms. + + Note that this option has no effect on other platforms: either native touch + is not supported by mpv, or the platform does not give an option to receive + emulated mouse inputs (so native touch is always enabled, e.g. Wayland). + ``--input-ar-delay`` Delay in milliseconds before we start to autorepeat a key (default: 200). Set it to 0 to disable. @@ -4123,6 +4139,12 @@ Input option is applied only during (lib)mpv initialization, and if disabled then it will not be not possible to enable them later. May be useful to libmpv clients. +``--input-builtin-dragging=<yes|no>`` + Enable the built-in window-dragging behavior (default: yes). Setting it to no + disables the built-in dragging behavior. Note that unlike the ``window-dragging`` + option, this option only affects VOs which support the ``begin-vo-dragging`` + command, and does not disable window dragging initialized with the command. + ``--input-cmdlist`` Prints all commands that can be bound to keys. @@ -4220,8 +4242,7 @@ Input ``--input-cursor=<yes|no>`` Permit mpv to receive pointer events reported by the video output - driver. Necessary to use the OSC, or to select the buttons in DVD menus. - Support depends on the VO in use. + driver. Necessary to use the OSC. Support depends on the VO in use. ``--input-cursor-passthrough=<yes|no>`` Tell the backend windowing system to allow pointer events to passthrough @@ -4281,6 +4302,18 @@ Input disabled by default in libmpv as well - it should be enabled if you want the mpv default key bindings. +``--input-touch-emulate-mouse=<yes|no>`` + When multi-touch support is enabled (either required by the platform, + or enabled by ``--native-touch``), emulate mouse move and button presses + for the touch events (default: yes). This is useful for compatibility + for mouse key bindings and scripts which read mouse positions for platforms + which do not support ``--native-touch=no`` (e.g. Wayland). + +``--input-dragging-deadzone=<N>`` + Begin the built-in window dragging when the mouse moves outside a deadzone of + ``N`` pixels while the mouse button is being held down (default: 3). This only + affects VOs which support the ``begin-vo-dragging`` command. + OSD --- @@ -4452,12 +4485,18 @@ OSD are always in actual pixels. The effect is that changing the window size won't change the OSD font size. + .. note:: + + For scripts which draw user interface elements, it is recommended to + respect the value of this option when deciding whether the elements + are scaled with window size or not. + ``--osd-shadow-color=<color>`` See ``--sub-color``. Color used for OSD shadow. .. note:: - ignored when ``--osd-back-color`` is specified (or more exactly: when + Ignored when ``--osd-back-color`` is specified (or more exactly: when that option is not set to completely transparent). ``--osd-shadow-offset=<size>`` @@ -6267,6 +6306,37 @@ them. macOS and cocoa-cb only. +``--cocoa-cb-output-csp=<csp>`` + This sets the color space of the layer to activate the macOS color + transformation. Depending on the color space used the system's EDR (HDR) + support will be activated. To get correct results, this needs to be set to + the color primaries/transfer characteristics of the VO target. It is recommended + to use this switch together with ``--target-trc`` and ``--target-prim``. + + ``<csp>`` can be one of the following: + + :auto: Sets the color space to the icc profile of the + screen (default). + :display-p3: DCI P3 primaries, a D65 white point and the sRGB + transfer function. + :display-p3-hlg: DCI P3 primaries, a D65 white point and the Hybrid + Log-Gamma (HLG) transfer function. + :display-p3-pq: DCI P3 primaries, a D65 white point and the Perceptual + Quantizer (PQ) transfer function. + :display-p3-linear: DCI P3 primaries, a D65 white point and linear transfer function. + :dci-p3: DCI P3 color space. + :bt.2020: ITU BT.2020 color space. + :bt.2020-linear: ITU BT.2020 color space and linear transfer function. + :bt.2100-hlg: ITU BT.2100 and the Hybrid Log-Gamma (HLG) transfer function. + :bt.2100-pq: ITU BT.2100 and the Perceptual Quantizer (PQ) transfer function. + :bt.709: ITU BT.709 color space. + :srgb: sRGB colorimetry and non-linear transfer function. + :srgb-linear: Same as sRGB but linear transfer function. + :rgb-linear: RGB and linear transfer function. + :adobe: Adobe RGB (1998) color space. + + macOS and cocoa-cb only. + ``--macos-title-bar-appearance=<appearance>`` Sets the appearance of the title bar (default: auto). Not all combinations of appearances and ``--macos-title-bar-material`` materials make sense or @@ -6394,6 +6464,9 @@ them. order. You can also pass ``help`` to get a complete list of compiled in backends (sorted by the default autoprobe order). + Note that the default GPU context is subject to change, and must not be relied upon. + If a certain GPU context needs to be used, it must be explicitly specified. + auto auto-select (default). Note that this context must be used alone and does not participate in the priority list. @@ -6436,7 +6509,9 @@ them. Controls which type of graphics APIs will be accepted: auto - Use any available API (default) + Use any available API (default). Note that the default GPU API used for this + value is subject to change, and must not be relied upon. If a certain GPU API + needs to be used, it must be explicitly specified. opengl Allow only OpenGL (requires OpenGL 2.1+ or GLES 2.0+) vulkan |