Merge remote-tracking branch 'cantabile/manpage_fixes'

5 files changed, 68 insertions, 121 deletions

diff --git a/DOCS/man/en/ao.rst b/DOCS/man/en/ao.rst
index 50f8c282c3..00dd1e9e6d 100644
--- a/DOCS/man/en/ao.rst
+++ b/DOCS/man/en/ao.rst
@@ -47,7 +47,7 @@ jack
 
     port=<name>
         Connects to the ports with the given name (default: physical ports).
-    name=<client
+    name=<client>
         Client name that is passed to JACK (default: MPlayer [<PID>]). Useful
         if you want to have certain connections established automatically.
     (no-)estimate
diff --git a/DOCS/man/en/changes.rst b/DOCS/man/en/changes.rst
index d0d6a55a54..ee08aa2a60 100644
--- a/DOCS/man/en/changes.rst
+++ b/DOCS/man/en/changes.rst
@@ -55,7 +55,7 @@ General changes for mplayer2 to mplayer3
 * Improved OpenGL output (``vo_gl3``)
 * Make ``--softvol`` default (**mplayer3** is not a mixer control panel)
 * Improved support for .cue files
-* Screenshot improvements (can save screenshots as JPG, configfurable filenames)
+* Screenshot improvements (can save screenshots as JPG, configurable filenames)
 * Removal of teletext support
 * Replace image VOs (``vo_jpeg`` etc.) with ``vo_image``
 * Remove ``vo_gif89a``, ``vo_md5sum``, ``vo_yuv4mpeg`` (the plan is to merge
diff --git a/DOCS/man/en/mplayer.rst b/DOCS/man/en/mplayer.rst
index 89c125a1e0..b287669d63 100644
--- a/DOCS/man/en/mplayer.rst
+++ b/DOCS/man/en/mplayer.rst
@@ -326,7 +326,7 @@ escape these on some shells.) Example:
 +-----------+-------------------------+
 
 Additionally, any file-local option changed at runtime is reset when the current
-file stops playing. If option ``-c`` is changed during playback of `file2.mkv`,
+file stops playing. If option ``--c`` is changed during playback of `file2.mkv`,
 it's reset when advancing to `file3.mkv`. This only affects file-local options.
 The option ``--a`` is never reset here.
 
@@ -358,8 +358,8 @@ as the file played and then tries to load any file-specific configuration.
 
 *EXAMPLE MPLAYER CONFIGURATION FILE:*
 
-| # Use Matrox driver by default.
-| vo=xmga
+| # Use gl3 video output by default.
+| vo=gl3
 | # I love practicing handstands while watching videos.
 | flip=yes
 | # Decode multiple files from PNG,
@@ -390,9 +390,6 @@ option. To end the profile, start another one or use the profile name
 | profile-desc="profile for .flv files"
 | flip=yes
 |
-| [vo.pnm]
-| outdir=/tmp
-|
 | [ao.alsa]
 | device=spdif
 
@@ -429,9 +426,9 @@ screenshots with the video filter is not instant: the screenshot will be only
 saved when the next video frame is displayed. This means attempting to take a
 screenshot while the player is paused will do nothing, until the user unpauses
 or seeks. Also, the screenshot filter is not compatible with hardware decoding,
-and actually will cause initialization failure when use with hardware decodingis
-attempted. Using the ``screenshot`` video filter is not recommended for these
-reasons.
+and actually will cause initialization failure when use with hardware decoding
+is attempted. Using the ``screenshot`` video filter is not recommended for
+these reasons.
 
 .. include:: changes.rst
 
@@ -494,7 +491,7 @@ libdvdcss:
            rely on a key exchange with the DVD drive, but rather uses a crypto
            attack to guess the title key. On rare cases this may fail because
            there is not enough encrypted data on the disc to perform a
-           statistical attack, but in the other hand it is the only way to
+           statistical attack, but on the other hand it is the only way to
            decrypt a DVD stored on a hard disc, or a DVD with the wrong region
            on an RPC2 drive.
 
@@ -519,12 +516,6 @@ libdvdcss:
         FIXME: Document this.
 
 libao2:
-    ``AO_SUN_DISABLE_SAMPLE_TIMING``
-        FIXME: Document this.
-
-    ``AUDIODEV``
-        FIXME: Document this.
-
     ``AUDIOSERVER``
         Specifies the Network Audio System server to which the nas audio
         output driver should connect and the transport that should be used. If
@@ -647,21 +638,12 @@ Play from a different DVD device:
 Play DVD video from a directory with VOB files:
     ``mplayer dvd://1 --dvd-device=/path/to/directory/``
 
-Copy a DVD title to hard disk, saving to file title1.vob :
-    ``mplayer dvd://1 --dumpstream --dumpfile=title1.vob``
-
 Stream from HTTP:
     ``mplayer http://mplayer.hq/example.avi``
 
 Stream using RTSP:
     ``mplayer rtsp://server.example.com/streamName``
 
-Convert subtitles to MPsub format:
-    ``mplayer dummy.avi --sub=source.sub --dumpmpsub``
-
-Convert subtitles to MPsub format without watching the movie:
-    ``mplayer /dev/zero --rawvideo=pal:fps=xx --demuxer=rawvideo --vc=null --vo=null --noframedrop --benchmark --sub=source.sub --dumpmpsub``
-
 input from standard V4L:
     ``mplayer tv:// --tv=driver=v4l:width=640:height=480:outfmt=i420 --vc=rawi420 --vo=xv``
 
diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst
index 8867810ef1..e875f9a8c3 100644
--- a/DOCS/man/en/options.rst
+++ b/DOCS/man/en/options.rst
@@ -264,10 +264,6 @@
     Play movie with window border and decorations. Since this is on by
     default, use ``--no-border`` to disable the standard window decorations.
 
---bpp=<depth>
-    Override the autodetected color depth. Only supported by the fbdev, dga,
-    svga, vesa video output drivers.
-
 --brightness=<-100-100>
     Adjust the brightness of the video signal (default: 0). Not supported by
     all video output drivers.
@@ -386,7 +382,8 @@
     format is RGB (if the video output driver supports RGB output, you can
     force this with ``-vf scale,format=rgba``).
 
-    If this option is set to ``auto`` (which is the default), the color space
+    If this option is set to ``auto`` (which is the default), the video's
+    color space flag will be used. If that flag is unset, the color space
     will be selected automatically. This is done using a simple heuristic that
     attempts to distinguish SD and HD video. If the video is larger than
     1279x576 pixels, BT.709 (HD) will be used; otherwise BT.601 (SD) is
@@ -408,7 +405,8 @@
 --colormatrix-input-range=<color-range>
     YUV color levels used with YUV to RGB conversion. This option is only
     necessary when playing broken files, which don't follow standard color
-    levels.
+    levels or which are flagged wrong. If the video doesn't specify its
+    color range, it is assumed to be limited range.
 
     The same limitations as with --colormatrix apply.
 
@@ -435,9 +433,8 @@
 
 --colorkey=<number>
     Changes the colorkey to an RGB value of your choice. 0x000000 is black and
-    0xffffff is white. Only supported by the fbdev, svga, vesa, xmga, xover,
-    xv (see ``--vo=xv:ck``) and directx video output drivers. See also
-    ``--no-colorkey``.
+    0xffffff is white. Only supported by the xv (see ``--vo=xv:ck``) video
+    output driver. See also ``--no-colorkey``.
 
 --consolecontrols, --no-consolecontrols
     ``--no-consolecontrols`` prevents the player from reading key events from
@@ -479,7 +476,7 @@
     OS X Cocoa.
 
 --delay=<sec>
-    audio delay in seconds (positive or negative float value) Negative values
+    audio delay in seconds (positive or negative float value). Negative values
     delay the audio, and positive values delay the video.
 
 --demuxer=<[+]name>
@@ -501,8 +498,7 @@
 
 --doubleclick-time
     Time in milliseconds to recognize two consecutive button presses as a
-    double-click (default: 300). Set to 0 to let your windowing system decide
-    what a double-click is (``--vo=directx`` only).
+    double-click (default: 300).
 
 --dvbin=<options>
     Pass the following parameters to the DVB input module, in order to
@@ -576,17 +572,6 @@
     reliable enough), the filename extension is used to select the demuxer.
     Always falls back on content-based demuxer selection.
 
---fbmode=<modename>
-    (``--vo=fbdev`` only)
-    Change video mode to the one that is labeled as <modename> in
-    ``/etc/fb.modes``.
-
-    *NOTE*: VESA framebuffer does not support mode changing.
-
---fbmodeconfig=<filename>
-    (``--vo=fbdev`` only)
-    Override framebuffer mode configuration file (default: ``/etc/fb.modes``).
-
 --ffactor=<number>
     Resample the font alphamap. Can be:
 
@@ -770,7 +755,7 @@
         Places the window at the bottom right corner of the screen.
 
 --grabpointer, --no-grabpointer
-    ``-no-grabpointer`` tells the player to not grab the mouse pointer after a
+    ``--no-grabpointer`` tells the player to not grab the mouse pointer after a
     video mode change (``--vm``). Useful for multihead setups.
 
 --hardframedrop
@@ -958,7 +943,7 @@
     default MPlayer tries to keep the correct video aspect ratio by
     instructing the window manager to maintain window aspect when resizing,
     and by adding black bars if the window manager nevertheless allows window
-    shape to change. This option disables window manager aspect hints and
+    shape to change. --no-keepaspect disables window manager aspect hints and
     scales the video to completely fill the window without regard for aspect
     ratio.
 
@@ -1191,18 +1176,6 @@
     the <name,number> format, i.e. a channel labeled 'PCM 1' in alsamixer must
     be converted to PCM,1.
 
---monitor-dotclock=<range[,range,...]>
-    Used with ``--vo=fbdev`` and ``--vo=vesa`` only.
-    Specify the dotclock or pixelclock range of the monitor.
-
---monitor-hfreq=<range[,range,...]>
-    Used with ``--vo=fbdev`` and ``--vo=vesa`` only.
-    Specify the horizontal frequency range of the monitor.
-
---monitor-vfreq=<range[,range,...]>
-    Used with ``--vo=fbdev`` and ``--vo=vesa`` only.
-    Specify the vertical frequency range of the monitor.
-
 --monitoraspect=<ratio>
     Set the aspect ratio of your monitor or TV screen. A value of 0 disables a
     previous setting (e.g. in the config file). Overrides the
@@ -1280,8 +1253,8 @@
     Turn off input stream caching. See ``--cache``.
 
 --no-colorkey
-    Disables colorkeying. Only supported by the fbdev, svga, vesa, xmga,
-    xover, xv (see ``--vo=xv:ck``) and directx video output drivers.
+    Disables colorkeying. Only supported by the xv (see ``--vo=xv:ck``) video
+    output driver.
 
 --no-config=<options>
     Do not parse selected configuration files.
@@ -1313,8 +1286,7 @@
 
 --ontop
     Makes the player window stay on top of other windows. Supported by video
-    output drivers which use X11, except SDL, as well as directx, corevideo
-    and ggi.
+    output drivers which use X11, as well as corevideo.
 
 --ordered-chapters, --no-ordered-chapters
     Enabled by default.
@@ -1391,7 +1363,7 @@
 
 --pp=<quality>
     This option only works when decoding video with Win32 DirectShow DLLs with
-    internal postprocessingi routines. See also ``--vf=pp``. Set the DLL
+    internal postprocessing routines. See also ``--vf=pp``. Set the DLL
     postprocess level. The valid range of ``--pp`` values varies by codec, it
     is mostly 0-6, where 0=disable, 6=slowest/best.
 
@@ -1488,9 +1460,9 @@
 
 --quiet
     Make console output less verbose; in particular, prevents the status line
-    (i.e. A: 0.7 V: 0.6 A-V: 0.068 ...) from being displayed. Particularly
-    useful on slow terminals or broken ones which do not properly handle
-    carriage return (i.e. \\r).
+    (i.e. AV: 3.4 (00:00:03.37) / 5320.6 ...) from being displayed.
+    Particularly useful on slow terminals or broken ones which do not properly
+    handle carriage return (i.e. \\r).
 
 --radio=<option1:option2:...>
     These options set various parameters of the radio capture module. For
@@ -1580,10 +1552,10 @@
 
     *EXAMPLE*:
 
-    - ``mplayer foreman.qcif --demuxer=rawvideo --rawvideo qcif`` Play the
+    - ``mplayer foreman.qcif --demuxer=rawvideo --rawvideo=qcif`` Play the
       famous "foreman" sample video.
 
-    - ``mplayer sample-720x576.yuv --demuxer=rawvideo --rawvideo w=720:h=576``
+    - ``mplayer sample-720x576.yuv --demuxer=rawvideo --rawvideo=w=720:h=576``
       Play a raw YUV sample.
 
 --really-quiet
@@ -1592,10 +1564,6 @@
 --referrer=<string>
     Specify a referrer path or URL for HTTP requests.
 
---refreshrate=<Hz>
-    Set the monitor refreshrate in Hz. Currently only supported by
-    ``--vo=directx`` combined with the ``--vm`` option.
-
 --reuse-socket
     (udp:// only)
     Allows a socket to be reused by other processes as soon as it is closed.
@@ -1649,12 +1617,16 @@
 
     Available choices:
 
-    :png:   PNG (default)
-    :jpg:   JPEG
+    :png:   PNG
+    :ppm:   PPM
+    :pgm:   PGM
+    :pgmyuv:   PGM with YV12 pixel format
+    :tga:   TARGA
+    :jpg:   JPEG (default)
     :jpeg:  JPEG (same as jpg, but with .jpeg file ending)
 
 --screenshot-jpeg-quality=<0-100>
-    Set the JPEG quality level. Higher means better quality. The default is 85.
+    Set the JPEG quality level. Higher means better quality. The default is 90.
 
 --screenshot-png-compression=<0-9>
     Set the PNG compression level. Higher means better compression. This will
@@ -1679,11 +1651,15 @@
 
     Allowed format specifiers:
 
-    ``%nX``
-        A sequence number, padded with zeros to length X. E.g. passing the
-        format ``%n4`` will yield ``0012`` on the 12th screenshot. The number is
-        incremented every time a screenshot is taken, or if the file already
-        exists. The length ``X`` must be in the range 0-9.
+    ``%[#][0X]n``
+        A sequence number, padded with zeros to length X (default: 04). E.g.
+        passing the format ``%04n`` will yield ``0012`` on the 12th screenshot.
+        The number is incremented every time a screenshot is taken, or if the
+        file already exists. The length ``X`` must be in the range 0-9. With
+        the optional # sign mplayer will use the lowest available number. For
+        example, if you take three screenshots--0001, 0002, 0003--and delete
+        the first two, the next two screenshots won't be 0004 and 0005, but
+        0001 and 0002 again.
     ``%f``
         Filename of the currently played video.
     ``%F``
@@ -1701,21 +1677,25 @@
         are not easily implementable, because container formats usually use
         time stamps for identifying frames.)
     ``%tX``
-        Specify the current local date/time using he format ``X``. This format
+        Specify the current local date/time using the format ``X``. This format
         specifier uses the UNIX ``strftime()`` function internally, and inserts
         the result of passing "%X" to ``strftime``. For example, ``%tm`` will
         insert the number of the current month as number. You have to use
         multiple ``%tX`` specifiers to build a full date/time string.
+    ``%{prop[:fallback text]}``
+        Insert the value of the slave property 'prop'. E.g. %{filename} is the
+        same as %f. If the property doesn't exist or is not available, nothing
+        is inserted, unless a fallback is specified.
     ``%%``
         Replaced with the ``%`` character itself.
 
 --screenh=<pixels>
     Specify the screen height for video output drivers which do not know the
-    screen resolution like fbdev, x11 and TV-out.
+    screen resolution, like x11 and TV-out.
 
 --screenw=<pixels>
     Specify the screen width for video output drivers which do not know the
-    screen resolution like fbdev, x11 and TV-out.
+    screen resolution, like x11 and TV-out.
 
 --show-profile=<profile>
     Show the description and content of a profile.
@@ -1757,14 +1737,13 @@
     changed output and use the --slave-broken switch. Instead, a new, saner
     protocol should be developed (and will, if there is enough interest).
 
-    This affects smplayer, smplayer2, mplayosx, and others.
+    This affects smplayer, smplayer2, mplayerosx, and others.
 
 --slices, --no-slices
     Drawing video by 16-pixel height slices/bands, instead draws the
     whole frame in a single run. May be faster or slower, depending on video
-    card and available cache. It has effect only with libmpeg2 and libavcodec
-    codecs. Enabled by default if applicable; usually disabled when threading
-    is used.
+    card and available cache. It has effect only with libavcodec codecs.
+    Enabled by default if applicable; usually disabled when threading is used.
 
 --softsleep
     Time frames by repeatedly checking the current time instead of asking
@@ -1777,7 +1756,7 @@
     audio filter.
 
 --softvol-max=<10.0-10000.0>
-    Set the maximum amplification level in percent (default: 110). A value of
+    Set the maximum amplification level in percent (default: 200). A value of
     200 will allow you to adjust the volume up to a maximum of double the
     current level. With values below 100 the initial volume (which is 100%)
     will be above the maximum, which e.g. the OSD cannot display correctly.
@@ -2243,11 +2222,6 @@
 
     *WARNING*: May be dangerous if playing from untrusted media.
 
---use-filename-title
-    Set the window title using the media filename, when not set with
-    ``--title``. Supported by X11-based video output drivers. See also
-    ``--title``.
-
 --user=<username>
     Used with some network protocols.
     Specify username for HTTP authentication. See also ``--passwd``.
@@ -2305,16 +2279,9 @@
     playing an MPEG-TS stream, MPlayer will use the first program (if present)
     with the chosen video stream.
 
---vivo=<suboption>
-    (DEBUG CODE)
-    Force audio parameters for the VIVO demuxer (for debugging purposes).
-    FIXME: Document this.
-
 --vm
-    Try to change to a different video mode. Supported by the dga, x11, xv,
-    sdl and directx video output drivers. If used with the directx video
-    output driver the ``--screenw``, ``--screenh``, ``--bpp`` and
-    ``--refreshrate`` options can be used to set the new display mode.
+    Try to change to a different video mode. Supported by the x11 and xv video
+    output drivers.
 
 --vo=<driver1[:suboption1[=value]:...],driver2,...[,]>
     Specify a priority list of video output drivers to be used. For
@@ -2402,5 +2369,5 @@
 
 --zoom
     Allow software scaling, where available. This will allow scaling with
-    output drivers (like x11, fbdev) that do not support hardware scaling
+    output drivers (like x11) that do not support hardware scaling,
     where MPlayer disables scaling by default for performance reasons.
diff --git a/DOCS/man/en/vo.rst b/DOCS/man/en/vo.rst
index 342230fbaf..0ba7fe8b9f 100644
--- a/DOCS/man/en/vo.rst
+++ b/DOCS/man/en/vo.rst
@@ -16,10 +16,8 @@ in the list. Suboptions are optional and can mostly be omitted.
 
 *EXAMPLE*:
 
-    ``--vo=xmga,xv,``
-        Try the Matrox X11 driver, then the Xv driver, then others.
-    ``--vo=directx:noaccel``
-        Uses the DirectX driver with acceleration features turned off.
+    ``--vo=gl,xv,``
+        Try the gl driver, then the Xv driver, then others.
 
 Available video output drivers are:
 
@@ -176,7 +174,7 @@ direct3d_shaders (Windows only)
     disable-eosd
         Disable EOSD rendering for subtitles.
         (Using this flag might force the insertion of the 'ass' video filter,
-         which will render the subtitles in software.)
+        which will render the subtitles in software.)
 
     disable-texture-align
         Normally texture sizes are always aligned to 16. With this option
@@ -427,7 +425,7 @@ gl
 
 gl3
     OpenGL video output driver, extended version. The requires an OpenGL 3
-    capable graphics driver. (Note: this is only because of developer pedantery.
+    capable graphics driver. (Note: this is only because of developer pedantry.
     The dependency on actual OpenGL 3 features is rather low.)
 
     It supports extended scaling methods, dithering and color management.
@@ -523,7 +521,7 @@ gl3
 
     pbo
         Enable use of PBOs. This is faster, but can sometimes lead to
-        sparodic and temporary image corruption.
+        sporadic and temporary image corruption.
 
     dither-depth=<n>
         Positive non-zero values select the target bit depth. Default: 0.
@@ -537,7 +535,7 @@ gl3
             Dither to 8 bit output.
 
         Note that dithering will always be disabled if the bit depth
-        of the video is lower or qual to the detected dither-depth.
+        of the video is lower or equal to the detected dither-depth.
         If color management is enabled, input depth is assumed to be
         16 bits, because the 3D LUT output is 16 bit wide.
 
@@ -552,7 +550,7 @@ gl3
 
 
     swapinterval=<n>
-        Interval in displayed frames between to buffer swaps.
+        Interval in displayed frames between two buffer swaps.
         1 is equivalent to enable VSYNC, 0 to disable VSYNC.
 
     no-scale-sep
@@ -621,7 +619,7 @@ gl3
         this file. This can be used to speed up loading, since
         LittleCMS2 can take a while to create the 3D LUT.
         Note that this file contains an uncompressed LUT. Its size depends on
-        the ``3dlut-size``, can be become very big.
+        the ``3dlut-size``, can become very big.
 
     icc-intent=<value>
         0
@@ -669,13 +667,13 @@ image
     png-compression=<0-9>
         PNG compression factor (speed vs. file size tradeoff) (default: 7)
     jpeg-quality=<0-100>
-        JPEG quality factor (default: 85)
+        JPEG quality factor (default: 90)
     [no-]jpeg-progressive
         Specify standard or progressive JPEG (default: noprogressive).
     [no-]jpeg-baseline
         Specify use of JPEG baseline or not (default: baseline).
     jpeg-optimize=<0-100>
-        JPEG ptimization factor (default: 100)
+        JPEG optimization factor (default: 100)
     jpeg-smooth=<0-100>
         smooth factor (default: 0)
     jpeg-dpi=<1->