manpage: cleanup

Removing text about things that have been removed from the code long
ago, other fixes.

1 files changed, 45 insertions, 116 deletions

diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst
index 6a8b81cd7f..3db799590e 100644
--- a/DOCS/man/en/options.rst
+++ b/DOCS/man/en/options.rst
@@ -19,16 +19,6 @@
 
     *NOTE*: See ``--ac=help`` for a full list of available codecs.
 
-    *EXAMPLE*:
-
-    :``--ac=mp3acm``:     Force the l3codeca.acm MP3 codec.
-    :``--ac=mad,``:       Try libmad first, then fall back on others.
-    :``--ac=hwac3,a52,``: Try hardware AC-3 passthrough, software AC-3, then
-                          others.
-    :``--ac=hwdts,``:     Try hardware DTS passthrough, then fall back on
-                          others.
-    :``--ac=-ffmp3,``:    Skip FFmpeg's MP3 decoder.
-
 --adapter=<value>
     Set the graphics card that will receive the image. You can get a list of
     available cards when you run this option with ``-v``. Currently only works
@@ -85,7 +75,6 @@
     *EXAMPLE*:
 
     :``--afm=ffmpeg``:    Try FFmpeg's libavcodec codecs first.
-    :``--afm=acm,dshow``: Try Win32 codecs first.
 
 --aid=<ID|auto|no>
     Select audio channel. ``auto`` selects the default, ``no`` disables audio.
@@ -130,9 +119,9 @@
     features in other subtitle formats by conversion to ASS markup. Enabled by
     default if the player was compiled with libass support.
 
-    *NOTE*: Some of the other subtitle options were written for the old
-    non-libass subtitle rendering system and may not work the same way or at
-    all with libass rendering enabled.
+    *NOTE*: With ``--ass``, some of the ASS subtitle options work for non-ASS
+    text subtitles only, because ASS subtitles include their own styling
+    information.
 
 --ass-border-color=<value>
     Sets the border (outline) color for text subtitles. The color format is
@@ -245,6 +234,8 @@
     is also used to set the maximum delivery bandwidth allowing faster cache
     filling and stream dumping.
 
+    *NOTE*: probably broken/useless.
+
 --untimed
     Do not sleep when outputting video frames. Useful for benchmarks when used
     with --no-audio.
@@ -322,7 +313,7 @@
         Add <value> sectors to the values reported when addressing tracks. May
         be negative.
 
-    (no)skip
+    (no-)skip
         (Never) accept imperfect data reconstruction.
 
 --cdrom-device=<path>
@@ -398,12 +389,6 @@
     :BT.601:        ITU-R BT.601 (SD)
     :BT.709:        ITU-R BT.709 (HD)
     :SMPTE-240M:    SMPTE-240M
-    :sd:            alias for BT.601
-    :hd:            alias for BT.709
-    :0:             compatibility alias for auto (do not use)
-    :1:             compatibility alias for BT.601 (do not use)
-    :2:             compatibility alias for BT.709 (do not use)
-    :3:             compatibility alias for SMPTE-240M (do not use)
 
 --colormatrix-input-range=<color-range>
     YUV color levels used with YUV to RGB conversion. This option is only
@@ -544,6 +529,8 @@
     EDL entries later. See http://www.mplayerhq.hu/DOCS/HTML/en/edl.html for
     details.
 
+    *NOTE*: broken.
+
 --embeddedfonts, --no-embeddedfonts
     Use fonts embedded in Matroska container files and ASS scripts (default:
     enabled). These fonts can be used for SSA/ASS subtitle rendering
@@ -591,15 +578,6 @@
 --flip
     Flip image upside-down.
 
---flip-hebrew
-    Turns on flipping subtitles using FriBiDi.
-
---flip-hebrew-commas, --no-flip-hebrew-commas
-    Enabled by default.
-    Change FriBiDi's assumptions about the placements of commas in subtitles.
-    Use this if commas in subtitles are shown at the start of a sentence
-    instead of at the end.
-
 --font=<pattern-or-filename>
     Specify font to use for OSD and for subtitles that do not themselves
     specify a particular font. See also ``--subfont``. With fontconfig enabled
@@ -637,6 +615,8 @@
 --fps=<float>
     Override video framerate. Useful if the original value is wrong or missing.
 
+    *NOTE*: Works in ``--no-correct-pts`` mode only.
+
 --framedrop=<no|yes|hard>
     Skip displaying some frames to maintain A/V sync on slow systems. Video
     filters are not applied to such frames. For B-frames even decoding is
@@ -644,15 +624,11 @@
     decoding and output of any frame can be skipped, and will lead to an even
     worse playback experience.
 
-    Practical use of this feature is questionable. Disabled by default.
+    *NOTE*: Practical use of this feature is questionable. Disabled by default.
 
 --frames=<number>
     Play/convert only first <number> frames, then quit.
 
---fribidi-charset=<name>
-    Specifies the character set that will be passed to FriBiDi when decoding
-    non-UTF-8 subtitles (default: ISO8859-8).
-
 --fullscreen
 --fs
     Fullscreen playback (centers movie, and paints black bands around it).
@@ -755,7 +731,7 @@
     Command that is executed every 30 seconds during playback via *system()* -
     i.e. using the shell.
 
-    *NOTE*: mpv uses this command without any checking, it is your
+    *NOTE*: mpv uses this command without any checking. It is your
     responsibility to ensure it does not cause security problems (e.g. make
     sure to use full paths if "." is in your path like on Windows). It also
     only works when playing video (i.e. not with ``--no-video`` but works with
@@ -773,7 +749,7 @@
     --heartbeat-cmd="gnome-screensaver-command -p" file``
 
 --help
-    Show short summary of options and key bindings.
+    Show short summary of options.
 
 --hr-mp3-seek
     Only affects the internal ``audio`` demuxer, which is not used by default
@@ -834,14 +810,7 @@
     drivers.
 
 --identify
-    Shorthand for ``--msglevel=identify=4``. Show file parameters in an easily
-    parseable format. Also prints more detailed information about subtitle and
-    audio track languages and IDs. In some cases you can get more information
-    by using ``--msglevel=identify=6``. For example, for a DVD or Blu-ray it
-    will list the chapters and time length of each title, as well as a disk
-    ID. Combine this with ``--frames=0`` to suppress all video output. The
-    wrapper script ``TOOLS/midentify.sh`` suppresses the other mpv output
-    and (hopefully) shellescapes the filenames.
+    Deprecated. Use ``TOOLS/mpv_identify.sh``.
 
 --idle
     Makes mpv wait idly instead of quitting when there is no file to play.
@@ -901,7 +870,7 @@
     ar-rate
         Number of key presses to generate per second on autorepeat.
 
-    (no)default-bindings
+    (no-)default-bindings
         Use the key bindings that mpv ships with by default.
 
     keylist
@@ -1139,7 +1108,7 @@
     generated from a different AVI, but this is sure to cause unfavorable
     results.
 
-    *NOTE*: This option is obsolete now that mpv has OpenDML support.
+    *NOTE*: This option is obsolete now that MPlayer has OpenDML support.
 
 --loop=<number|inf|no>
     Loops playback <number> times. ``inf`` means forever and ``no`` disables
@@ -1320,7 +1289,7 @@
     values mean multiples of the default range. Negative numbers mean you can
     zoom in up to a factor of ``--panscanrange=+1``. E.g. ``--panscanrange=-3``
     allows a zoom factor of up to 4. This feature is experimental. Do not
-    report bugs unless you are using ``--vo=gl``.
+    report bugs unless you are using ``--vo=opengl``.
 
 --passwd=<password>
     Used with some network protocols. Specify password for HTTP authentication.
@@ -1349,7 +1318,7 @@
     $$
         Expands to ``$``.
     $}
-        Expands to ``}``. (To produce this character inside rexursive
+        Expands to ``}``. (To produce this character inside recursive
         expansion.)
     $>
         Disable property expansion and special handling of ``$`` for the rest
@@ -1371,19 +1340,12 @@
     sources. Do NOT use ``--playlist`` with random internet sources or files
     you don't trust!
 
-    *NOTE*: This option is considered an entry so options found after it will
-    apply only to the elements of this playlist.
-
     FIXME: This needs to be clarified and documented thoroughly.
 
 --pp=<quality>
-    This option only works when decoding video with Win32 DirectShow DLLs with
-    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.
+    See also ``--vf=pp``.
 
 --pphelp
-    Show a summary about the available postprocess filters and their usage.
     See also ``--vf=pp``.
 
 --prefer-ipv4
@@ -1585,18 +1547,6 @@
     images may cover the movie window, though. May not work with all video
     output drivers.
 
---rtsp-destination
-    Used with ``rtsp://`` URLs to force the destination IP address to be
-    bound. This option may be useful with some RTSP server which do not send
-    RTP packets to the right interface. If the connection to the RTSP server
-    fails, use ``-v`` to see which IP address mpv tries to bind to and try
-    to force it to one assigned to your computer instead.
-
---rtsp-port
-    Used with ``rtsp://`` URLs to force the client's port number. This option
-    may be useful if you are behind a router and want to forward the RTSP
-    stream from the server to a specific client.
-
 --saturation=<-100-100>
     Adjust the saturation of the video signal (default: 0). You can get
     grayscale output with this option. Not supported by all video output
@@ -1606,7 +1556,7 @@
     Force index rebuilding and dump the index to <filename>. Currently this
     only works with AVI files.
 
-    *NOTE*: This option is obsolete now that mpv has OpenDML support.
+    *NOTE*: This option is obsolete now that MPlayer has OpenDML support.
 
 --sb=<n>
     Seek to byte position. Useful for playback from CD-ROM images or VOB files
@@ -1683,9 +1633,9 @@
         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.
+        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,
+        an error text is inserted, unless a fallback is specified.
     ``%%``
         Replaced with the ``%`` character itself.
 
@@ -1759,10 +1709,10 @@
     :yes:   always use the volume filter
     :auto:  prefer the volume filter if the audio driver uses the system mixer (default)
 
-    The intention with ``auto`` is to avoid changing system mixer settings with
-    default settings. mpv is a video player, not a mixer panel. On the other
-    hand, mixer controls should be used for sound servers like PulseAudio, which
-    provide per-application volume.
+    The intention of ``auto`` is to avoid changing system mixer settings from
+    within mpv with default settings. mpv is a video player, not a mixer panel.
+    On the other hand, mixer controls are enabled for sound servers like
+    PulseAudio, which provide per-application volume.
 
 --softvol-max=<10.0-10000.0>
     Set the maximum amplification level in percent (default: 200). A value of
@@ -1800,11 +1750,12 @@
     :chs=<h>:       chroma horizontal shifting
     :cvs=<v>:       chroma vertical shifting
 
-    *EXAMPLE*: ``--vf=scale=-ssf=lgb=3.0``
+    *EXAMPLE*: ``--vf=scale --ssf=lgb=3.0``
 
 --sstep=<sec>
-    Skip <sec> seconds after every frame. Since mpv will only seek to
-    the next keyframe unless you use ``--hr-seek`` this may be inexact.
+    Skip <sec> seconds after every frame.
+
+    *NOTE*: without ``--hr-seek``, skipping will snap to keyframes.
 
 --stereo=<mode>
     Select type of MP2/MP3 stereo output.
@@ -1884,17 +1835,17 @@
     Delays subtitles by <sec> seconds. Can be negative.
 
 --subfile=<filename>
-    (BETA CODE)
-    Currently useless. Same as ``--audiofile``, but for subtitle streams
-    (OggDS?).
+    Open the given file with a demuxer, and use its subtitle streams. Same as
+    ``--audiofile``, but for subtitle streams.
+
+    Use ``--sub`` for normal text subtitle files.
 
 --subfont=<pattern-or-filename>
     Sets the subtitle font (see ``--font``). If no ``--subfont`` is given,
     ``--font`` is used for subtitles too.
 
 --subfont-text-scale=<0-100>
-    Sets the subtitle text autoscale coefficient as percentage of the screen
-    size (default: 3.5).
+    Factor for the text subtitle and OSD font size (default: 6).
 
 --subfps=<rate>
     Specify the framerate of the subtitle file (default: movie fps).
@@ -1938,8 +1889,9 @@
     console. The escape sequence should move the pointer to the beginning of
     the line used for the OSD and clear it (default: ``^[[A\r^[[K``).
 
---title
-    Set the window title. Properties are expanded (see ``--playing-msg``).
+--title=<string>
+    Set the window title. Properties are expanded on playback start
+    (see ``--playing-msg``).
 
 --tv=<option1:option2:...>
     This option tunes various properties of the TV capture module. For
@@ -2181,13 +2133,6 @@
 
     *NOTE*: See ``--vc=help`` for a full list of available codecs.
 
-    *EXAMPLE*:
-
-    :``--vc=divx``:             Force Win32/VfW DivX codec, no fallback.
-    :``--vc=-divxds,-divx,``:   Skip Win32 DivX codecs.
-    :``--vc=ffmpeg12,mpeg12,``: Try libavcodec's MPEG-1/2 codec, then
-                                libmpeg2, then others.
-
 --vf=<filter1[=parameter1:parameter2:...],filter2,...>
     Specify a list of video filters to apply to the video stream. See
     :ref:`video_filters` for details and descriptions of the available filters.
@@ -2202,14 +2147,6 @@
 
     *NOTE*: See ``--vfm=help`` for a full list of available codec families.
 
-    *EXAMPLE*:
-
-    :``--vfm=ffmpeg,dshow,vfw``:
-        Try the libavcodec, then Directshow, then VfW codecs and fall back on
-        others, if they do not work.
-    :``--vfm=xanim``:
-        Try XAnim codecs first.
-
 --vid=<ID|auto|no>
     Select video channel. ``auto`` selects the default, ``no`` disables video.
 
@@ -2235,21 +2172,15 @@
     (default: 3).
 
 --volume=<-1-100>
-    Set the startup volume in the mixer, either hardware or software (if used
-    with ``--softvol``). A value of -1 (the default) will not change the
-    volume. See also ``--af=volume``.
+    Set the startup volume. A value of -1 (the default) will not change the
+    volume. See also ``--softvol``.
 
 --no-vsync
-    Tries to disable vsync.
+    Tries to disable vsync. (Effective with some video outputs only.)
 
 --wid=<ID>
-    (X11, OpenGL and DirectX only)
-    This tells mpv to attach to an existing window. Useful to embed
-    mpv in a browser (e.g. the plugger extension). Earlier this option
-    always filled the given window completely, thus aspect scaling, panscan,
-    etc were no longer handled by mpv but had to be managed by the
-    application that created the window. Now aspect is maintained by default.
-    If you don't want that use ``--no-keepaspect``.
+    (X11 and win32 only)
+    This tells mpv to attach to an existing window.See ``--slave-broken``.
 
 --x=<width>
     Scale image to width <width> (if software/hardware scaling is available).
@@ -2302,6 +2233,4 @@
     Disables aspect calculations.
 
 --zoom
-    Allow software scaling, where available. This will allow scaling with
-    output drivers (like x11) that do not support hardware scaling,
-    where mpv disables scaling by default for performance reasons.
+    Useful for ``--vo=x11`` only. Enables scaling.