From 588dd8f66058f7b31d0693e34c0e9385606cf1d5 Mon Sep 17 00:00:00 2001 From: Danny Rawlins Date: Fri, 5 Nov 2021 09:03:43 +1100 Subject: [PATCH] mpv: add updated man page --- mpv/mpv.1 | 905 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 633 insertions(+), 272 deletions(-) diff --git a/mpv/mpv.1 b/mpv/mpv.1 index bed207d59..9d1cda3ed 100644 --- a/mpv/mpv.1 +++ b/mpv/mpv.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH MPV 1 "" "" "multimedia" -.SH NAME -mpv \- a media player . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.TH "MPV" 1 "" "" "multimedia" +.SH NAME +mpv \- a media player .SH SYNOPSIS .nf \fBmpv\fP [options] [file|URL|PLAYLIST|\-] @@ -57,6 +57,9 @@ See the \fB\-\-input\-\fP options for ways to customize it. The following listings are not necessarily complete. See \fBetc/input.conf\fP for a list of default bindings. User \fBinput.conf\fP files and Lua scripts can define additional key bindings. +.sp +See also \fB\-\-input\-test\fP for interactive binding details by key, and the +\fI\%stats\fP built\-in script for key bindings list (including print to terminal). .SS Keyboard Control .INDENT 0.0 .TP @@ -243,7 +246,7 @@ file such as codec, framerate, number of dropped frames and so on. See \fI\%STATS\fP for more information. .TP .B del -Cycles visibility between never / auto (mouse\-move) / always +Cycle OSC visibility between never / auto (mouse\-move) / always .TP .B \(ga Show the console. (ESC closes it again. See \fI\%CONSOLE\fP\&.) @@ -265,16 +268,16 @@ Adjust gamma. .B 7 and 8 Adjust saturation. .TP -.B Alt+0 (and command+0 on OSX) +.B Alt+0 (and command+0 on macOS) Resize video window to half its original size. .TP -.B Alt+1 (and command+1 on OSX) +.B Alt+1 (and command+1 on macOS) Resize video window to its original size. .TP -.B Alt+2 (and command+2 on OSX) +.B Alt+2 (and command+2 on macOS) Resize video window to double its original size. .TP -.B command + f (OSX only) +.B command + f (macOS only) Toggle fullscreen (see also \fB\-\-fs\fP). .UNINDENT .sp @@ -423,6 +426,9 @@ Or in a script: .UNINDENT .UNINDENT .sp +Note: where applicable with JSON\-IPC, \fB%n%\fP is the length in UTF\-8 bytes, +after decoding the JSON data. +.sp Suboptions passed to the client API are also subject to escaping. Using \fBmpv_set_option_string()\fP is exactly like passing \fB\-\-name=data\fP to the command line (but without shell processing of the string). Some options @@ -458,8 +464,9 @@ need to escape special characters. To work this around, the path can be additionally wrapped in the fixed\-length syntax, e.g. \fB%n%string_of_length_n\fP (see above). .sp -Some mpv options interpret paths starting with \fB~\fP\&. Currently, the prefix -\fB~~/\fP expands to the mpv configuration directory (usually \fB~/.config/mpv/\fP). +Some mpv options interpret paths starting with \fB~\fP\&. +Currently, the prefix \fB~~home/\fP expands to the mpv configuration directory +(usually \fB~/.config/mpv/\fP). \fB~/\fP expands to the user\(aqs home directory. (The trailing \fB/\fP is always required.) The following paths are currently recognized: .TS @@ -475,7 +482,11 @@ _ T{ \fB~~/\fP T} T{ -mpv config dir (for example \fB~/.config/mpv/\fP) +If the subpath exists in any of the mpv\(aqs config directories +the path of the existing file/dir is returned. Otherwise this +is equivalent to \fB~~home/\fP\&. +Note that if \-\-no\-config is used \fB~~/foobar\fP will resolve to +\fBfoobar\fP which can be unexpected. T} _ T{ @@ -487,7 +498,7 @@ _ T{ \fB~~home/\fP T} T{ -same as \fB~~/\fP +mpv config dir (for example \fB~/.config/mpv/\fP) T} _ T{ @@ -499,24 +510,24 @@ _ T{ \fB~~osxbundle/\fP T} T{ -the OSX bundle resource path (OSX only) +the macOS bundle resource path (macOS only) T} _ T{ \fB~~desktop/\fP T} T{ -the path to the desktop (win32, OSX) +the path to the desktop (win32, macOS) T} _ T{ -\fB~~exe_dir\fP +\fB~~exe_dir/\fP T} T{ win32 only: the path to the directory containing the exe (for config file purposes; \fB$MPV_HOME\fP overrides it) T} _ T{ -\fB~~old_home\fP +\fB~~old_home/\fP T} T{ do not use T} @@ -647,7 +658,7 @@ _ T{ \-set T} T{ -Set a list of items (using the list separator, interprets escapes) +Set a list of items (using the list separator, escaped with backslash) T} _ T{ @@ -1073,9 +1084,11 @@ ignored. This Lua code execution is not sandboxed. .sp Any variables in condition expressions can reference properties. If an identifier is not already defined by Lua or mpv, it is interpreted as property. -For example, \fBpause\fP would return the current pause status. If the variable -name contains any \fB_\fP characters, they are turned into \fB\-\fP\&. For example, -\fBplayback_time\fP would return the property \fBplayback\-time\fP\&. +For example, \fBpause\fP would return the current pause status. You cannot +reference properties with \fB\-\fP this way since that would denote a subtraction, +but if the variable name contains any \fB_\fP characters, they are turned into +\fB\-\fP\&. For example, \fBplayback_time\fP would return the property +\fBplayback\-time\fP\&. .sp A more robust way to access properties is using \fBp.property_name\fP or \fBget("property\-name", default_value)\fP\&. The automatic variable to property @@ -1336,7 +1349,7 @@ The current time position in \fBHH:MM:SS\fP format (\fBplayback\-time\fP propert .IP \(bu 2 The total file duration (absent if unknown) (\fBduration\fP property) .IP \(bu 2 -Playback speed, e.g. \(ga\(ga x2.0\(ga\(ga. Only visible if the speed is not normal. This +Playback speed, e.g. \fBx2.0\fP\&. Only visible if the speed is not normal. This is the user\-requested speed, and not the actual speed (usually they should be the same, unless playback is too slow). (\fBspeed\fP property.) .IP \(bu 2 @@ -1680,7 +1693,7 @@ or file associations provided by desktop environments) if started from explorer.exe on Windows (technically, if it was started on Windows, and all of the stdout/stderr/stdin handles are unset) .IP \(bu 2 -started out of the bundle on OSX +started out of the bundle on macOS .IP \(bu 2 if you manually use \fB\-\-player\-operation\-mode=pseudo\-gui\fP on the command line .UNINDENT @@ -1733,7 +1746,7 @@ profile name. .SH LINUX DESKTOP ISSUES .sp This subsection describes common problems on the Linux desktop. None of these -problems exist on systems like Windows or OSX. +problems exist on systems like Windows or macOS. .SS Disabling Screensaver .sp By default, mpv tries to disable the OS screensaver during playback (only if @@ -1840,7 +1853,7 @@ others) sometimes expose behavior that may appear strange. Also, the behavior tends to change around with each mpv release. .sp The track selection properties will return the option value outside of -playback (as expected), but during playbac, the affective track +playback (as expected), but during playback, the affective track selection is returned. For example, with \fB\-\-aid=auto\fP, the \fBaid\fP property will suddenly return \fB2\fP after playback initialization (assuming the file has at least 2 audio tracks, and the second is the @@ -2009,7 +2022,7 @@ disabled with \fBno\fP\&. Slow down or speed up playback by the factor given as parameter. .sp If \fB\-\-audio\-pitch\-correction\fP (on by default) is used, playing with a -speed higher than normal automatically inserts the \fBscaletempo\fP audio +speed higher than normal automatically inserts the \fBscaletempo2\fP audio filter. .TP .B \fB\-\-pause\fP @@ -2213,6 +2226,16 @@ just the file itself. If the playlist contains only a single file, the difference between the two option is that this option performs a seek on loop, instead of reloading the file. .sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +\fB\-\-loop\-file\fP counts the number of times it causes the player to +seek to the beginning of the file, not the number of full playthroughs. This +means \fB\-\-loop\-file=1\fP will end up playing the file twice. Contrast with +\fB\-\-loop\-playlist\fP, which counts the number of full playthroughs. +.UNINDENT +.UNINDENT +.sp \fB\-\-loop\fP is an alias for this option. .TP .B \fB\-\-ab\-loop\-a=