man page review part VIII

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@13220 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 69 insertions, 64 deletions

diff --git a/DOCS/man/en/mplayer.1 b/DOCS/man/en/mplayer.1
index a8b74e3a09..1fc0328584 100644
--- a/DOCS/man/en/mplayer.1
+++ b/DOCS/man/en/mplayer.1
@@ -501,10 +501,10 @@ Available commands are:
 .sp 1
 .PD 0
 .RSs
-.IPs conf=<file>
+.IPs conf=<filename>
 Specify input configuration file other than the default
 ~/\:.mplayer/\:input.conf.
-~/\:.mplayer/\:<file> is assumed if no full path is given.
+~/\:.mplayer/\:<filename> is assumed if no full path is given.
 .IPs ar-delay
 Delay in msec before we start to autorepeat a key (0 to disable).
 .IPs ar-rate
@@ -526,7 +526,7 @@ several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
 .PD 1
 .
 .TP
-.B \-lircconf <file> (LIRC only)
+.B \-lircconf <filename> (LIRC only)
 Specifies a configuration file for LIRC (default: ~/\:.lircrc).
 .
 .TP
@@ -543,7 +543,7 @@ Loops movie playback <number> times.
 Turn on OSD menu support.
 .
 .TP
-.B \-menu-cfg <file> (OSD menu only)
+.B \-menu-cfg <filename> (OSD menu only)
 Use an alternative menu.conf.
 .
 .TP
@@ -579,7 +579,7 @@ Turns off usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
 mechanism.
 .
 .TP
-.B \-playlist <file>
+.B \-playlist <filename>
 Play files according to a playlist file (ASX, Winamp, SMIL, or
 one-file-per-line format).
 .br
@@ -621,7 +621,8 @@ Switches on slave mode, in which MPlayer works as a backend for other programs.
 Instead of intercepting keyboard events, MPlayer will read commands from stdin.
 .br
 .I NOTE:
-See DOCS/\:tech/\:slave.txt and \-input cmdlist for a list of slave commands.
+See \-input cmdlist for a list of slave commands and DOCS/\:tech/\:slave.txt
+for their description.
 .
 .TP
 .B \-softsleep
@@ -652,7 +653,7 @@ This option only shows an effect if the AC3 stream contains the required range
 compression information.
 .
 .TP
-.B \-aid <id> (also see \-alang)
+.B \-aid <ID> (also see \-alang)
 Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
 VOB(AC3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
 MPlayer prints the available IDs when run in verbose (\-v) mode.
@@ -784,7 +785,7 @@ full 5.1
 .PD 1
 .
 .TP
-.B \-chapter <chapter\ id>[\-<end\ chapter\ id>] (DVD only)
+.B \-chapter <chapter\ ID>[\-<end\ chapter\ ID>] (DVD only)
 Specify which chapter to start playing at.
 Optionally specify which chapter to end playing at (default: 1).
 .
@@ -831,8 +832,8 @@ the default ones:
 .RSs
 .IPs card=<1\-4>
 Specifies using card number 1\-4 (default: 1).
-.IPs file=<file>
-Instructs MPlayer to read the channels list from <file>.
+.IPs file=<filename>
+Instructs MPlayer to read the channels list from <filename>.
 Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl} (based on your card type)
 or ~/.mplayer/\:channels.conf as a last resort.
 .RE
@@ -843,7 +844,7 @@ or ~/.mplayer/\:channels.conf as a last resort.
 Specify the DVD device (default: /dev/\:dvd).
 .
 .TP
-.B \-dvdangle <angle\ id> (DVD only)
+.B \-dvdangle <angle\ ID> (DVD only)
 Some DVD discs contain scenes that can be viewed from multiple angles.
 Here you can tell MPlayer which angles to use (default: 1).
 .
@@ -1189,15 +1190,15 @@ Choose the quality of the JPEG compression
 .RE
 .
 .TP
-.B \-user <user name> (also see \-passwd) (network only)
-Specify user name for HTTP authentication.
+.B \-user <username> (also see \-passwd) (network only)
+Specify username for HTTP authentication.
 .
 .TP
 .B \-user-agent <string>
 Use <string> as user agent for HTTP streaming.
 .
 .TP
-.B \-vid <id>
+.B \-vid <ID>
 Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
 (if present) with the chosen video stream.
@@ -2061,7 +2062,7 @@ Places the window at the bottom right corner of the screen.
 .PD 1
 .
 .TP
-.B \-guiwid <window\ id> (also see \-wid) (GUI only)
+.B \-guiwid <window\ ID> (also see \-wid) (GUI only)
 This tells the GUI to also use an X11 window and stick itself to the bottom
 of the video, which is useful to embed a mini-GUI in a browser (with the
 MPlayer plugin for instance).
@@ -2202,7 +2203,7 @@ the new display mode.
 Enables VBI for the vesa, dfbmga and svga video output drivers.
 .
 .TP
-.B \-wid <window\ id> (also see \-guiwid) (X11 only)
+.B \-wid <window\ ID> (also see \-guiwid) (X11 only)
 This tells MPlayer to attach to an existing X11 window.
 Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
 .
@@ -2549,7 +2550,7 @@ like most MPEG movies are.
 You need to enable this option if you have tearing issues/\:unsmooth
 motions watching interlaced film material.
 .IPs layer=N
-Will force layer with id N for playback (default: -1 - auto).
+Will force layer with ID N for playback (default: -1 - auto).
 .RE
 .PD 1
 .
@@ -2769,7 +2770,7 @@ Skip FFmpeg's MP3 decoder.
 .PD 1
 .
 .TP
-.B \-af <filter1[=option1:option2:...],filter2,...>
+.B \-af <filter1[=parameter1:parameter2:...],filter2,...>
 Activate a comma separated list of audio filters and their options.
 Also see the audio filters section of the documentation.
 .sp 1
@@ -3247,24 +3248,23 @@ Video filters allow you to modify the video stream and its properties.
 The syntax is:
 .
 .TP
-.B \-vf <filter1[=parameters],filter2,...>
+.B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
 Setup a chain of video filters.
 .
 .TP
-.B \-vop <...,filter3[=parameters],filter2,filter1> (OBSOLETE)
+.B \-vop <...,filter2[=parameter1:parameter2:...],filter1> (OBSOLETE)
 Setup a chain of video filters, to be applied in
 .B reverse
 order.
 Deprecated in favor of \-vf.
 .PP
-The parameters are optional and if omitted, some of them are set to default
-values.
-Use '-1' to keep the default value.
+Many parameters are optional and set to default values if omitted.
+To explicitly use a default value set a parameter to '-1'.
 Parameters w:h means width x height in pixels, x:y means x;y position counted
 from the upper left corner of the bigger image.
 .br
 .I NOTE:
-To get a full list of available filters, see \-vf help.
+To get a full list of available video filters, see \-vf help.
 .sp 1
 Filters are managed in lists.
 There are a few commands to manage the filter list.
@@ -3518,8 +3518,7 @@ format name like rgb15, bgr24, yv12, etc (default: yv12)
 .B pp[=filter1[:option1[:option2...]]/\:[-]filter2...] (also see \-pphelp)
 This option enables usage of MPlayer's internal postprocessing filter,
 and also gives an interface where you can pass options to the named filter.
-To get a list of available filters, use \-pphelp.
-Note that each sub-filter must be separated with a / sign.
+Subfilters must be separated by /.
 Each filter defaults to 'c' (chrominance).
 The keywords accept a '-' prefix to disable the option.
 A ':' followed by a letter may be appended to the option to indicate its
@@ -3536,6 +3535,10 @@ Do not do chrominance filtering (only luminance filtering).
 .PD 1
 .sp 1
 .RS
+.br
+.I NOTE:
+\-pphelp shows a list of available postprocessing filters.
+.sp 1
 .I EXAMPLE:
 .RE
 .PD 0
@@ -3563,7 +3566,7 @@ simple postprocessing filter
 .IPs quality
 0\-6 (default: 3)
 .IPs qp\ \ \ 
-force quantization parameter (default: 0, use qp from video)
+force quantization parameter (default: 0, use QP from video)
 .IPs mode\ \ \ 
 0: hard thresholding (default)
 .br
@@ -3572,7 +3575,7 @@ force quantization parameter (default: 0, use qp from video)
 .
 .TP
 .B qp=equation
-qp change filter
+QP change filter
 .RSs
 .IPs equation
 some equation like "2+2*sin(PI*qp)"
@@ -3886,6 +3889,7 @@ Set the frame dropping mode.
 1 means always drop a frame when there have been no drops or telecine
 merges in the past 5 frames.
 2 means always maintain exact 5:4 input to output frame ratio.
+.br
 .I NOTE:
 Use mode 1 or 2 with MEncoder.
 .IPs am
@@ -4050,7 +4054,7 @@ In order to use divtc two-pass with two-pass video encoding, you must perform
 three passes: first divtc pass 1 and encoder pass 1, then divtc pass 2 and
 encoder pass 1, and finally divtc pass 2 and encoder pass 2.
 .IPs file=filename
-Set the 2-pass log file name (default: "framediff.log").
+Set the 2-pass log filename (default: "framediff.log").
 .IPs threshold=value
 Set the minimum strength the telecine pattern must have for the filter to
 believe in it (default: 0.5).
@@ -4924,9 +4928,9 @@ DivX 3
 .IPs msmpeg4v2
 MS MPEG4v2
 .IPs wmv1
-Windows Media Video, version 1 (aka WMV7)
+Windows Media Video, version 1 (AKA WMV7)
 .IPs wmv2
-Windows Media Video, version 2 (aka WMV8)
+Windows Media Video, version 2 (AKA WMV8)
 .IPs rv10
 an old RealVideo codec
 .IPs mpeg1video
@@ -5753,7 +5757,7 @@ the minimum of error and lambda*bits.
 .PD 0
 .RSs
 .IPs lambda
-qp dependant constant
+QP dependant constant
 .IPs bits\ 
 amount of bits needed to encode the block
 .IPs error
@@ -5813,8 +5817,8 @@ This has a significant effect on speed.
 .
 .TP
 .B psnr\ \ \ 
-print the psnr (peak signal to noise ratio) for the whole video after encoding
-and store the per frame psnr in a file with a name like 'psnr_hhmmss.log'.
+print the PSNR (peak signal to noise ratio) for the whole video after encoding
+and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
 Returned values are in dB (decibel), the higher the better.
 .
 .TP
@@ -6219,8 +6223,8 @@ filter chain.
 .
 .TP
 .B psnr\ \ \ 
-Print the psnr (peak signal to noise ratio) for the whole video after encoding
-and store the per frame psnr in a file with a name like 'psnr_hhmmss.log' in
+Print the PSNR (peak signal to noise ratio) for the whole video after encoding
+and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
 the current directory.
 Returned values are in dB (decibel), the higher the better.
 .
@@ -6382,7 +6386,7 @@ Adjust the amount of logging info printed to the screen.
 .br
  2: PSNR and other analysis stats when the encode finishes (default)
 .br
- 3: PSNR, qp, frametype, size, and other stats for every frame
+ 3: PSNR, QP, frametype, size, and other stats for every frame
 .REss
 .
 .TP
@@ -6397,7 +6401,7 @@ Print signal-to-noise ratio statistics.
 .SH FILES
 .
 .TP
-/etc/\:mplayer/\:mplayer.conf
+/usr/\:/local\:etc/\:mplayer/\:mplayer.conf
 system-wide settings
 .
 .TP
@@ -6425,9 +6429,10 @@ font directory (There must be a font.desc file and files with .RAW extension.)
 cached CSS keys
 .
 .TP
-Sub files are searched for in this order (for example /mnt/\:cdrom/\:movie.avi):
+Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
+in this order:
 .RS
-/mnt/\:cdrom/\:movie.sub
+/path/\:to/\:movie.sub
 .br
 ~/.mplayer/\:sub/\:movie.sub
 .br
@@ -6443,92 +6448,92 @@ Sub files are searched for in this order (for example /mnt/\:cdrom/\:movie.avi):
 .SH EXAMPLES
 .
 .TP
-.B Quickstart DVD playing
+.B quickstart DVD playing:
 mplayer dvd://1
 .
 .TP
-.B Play in japanese with english subtitles
+.B Play in Japanese with English subtitles:
 mplayer dvd://1 \-alang ja \-slang en
 .
 .TP
-.B Play only chapters 5, 6, 7
+.B Play only chapters 5, 6, 7:
 mplayer dvd://1 \-chapter 5-7
 .
 .TP
-.B Play only titles 5, 6, 7
+.B Play only titles 5, 6, 7:
 mplayer dvd://5-7
 .
 .TP
-.B Multiangle DVD playing
+.B Play a multiangle DVD:
 mplayer dvd://1 \-dvdangle 2
 .
 .TP
-.B Playing from a different DVD device
+.B Play from a different DVD device:
 mplayer dvd://1 \-dvd-device /dev/\:dvd2
 .
 .TP
-.B Stream from HTTP
+.B Stream from HTTP:
 mplayer http://mplayer.hq/\:example.avi
 .
 .TP
-.B Stream using RTSP
+.B Stream using RTSP:
 mplayer rtsp://server.example.com/\:streamName
 .
 .TP
-.B Convert subtitle to MPsub (to ./dump.mpsub)
+.B Convert subtitles to MPsub format:
 mplayer dummy.avi \-sub source.sub \-dumpmpsub
 .
 .TP
-.B Convert subtitle to MPsub without watching the movie
+.B Convert subtitles to MPsub format without watching the movie:
 mplayer /dev/\:zero \-rawvideo on:pal:fps=xx \-vc null \-vo null \-noframedrop
 \-benchmark \-sub source.sub \-dumpmpsub
 .
 .TP
-.B Input from standard V4L
+.B input from standard V4L:
 mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420
 \-vo xv
 .
 .TP
-.B Playback on Zoran card (old style, deprecated)
+.B Playback on Zoran cards (old style, deprecated):
 mplayer \-vo zr \-vf scale=352:288 file.avi
 .
 .TP
-.B Playback on Zoran card (new style)
+.B Playback on Zoran cards (new style):
 mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
 .
 .TP
-.B Encoding DVD title #2, only selected chapters
+.B Encode DVD title #2, only selected chapters:
 mencoder dvd://2 \-chapter 10-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
 .
 .TP
-.B Encoding DVD title #2, resizing to 640x480
+.B Encode DVD title #2, resizing to 640x480:
 mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
 .
 .TP
-.B Encoding DVD title #2, resizing to 512xHHH (keep aspect ratio)
+.B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
 mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy
 \-ovc lavc \-lavcopts vcodec=mpeg4
 .
 .TP
-.B The same, but with libavcodec family, MPEG4 (Divx5) compression
-mencoder dvd://2 \-o title2.avi \-ovc lavc
-\-lavcopts vcodec=mpeg4:vhq:vbitrate=1800 \-oac copy
+.B The same, but with bitrate set to 1800kBit and optimized macroblocks:
+mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc
+\-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
 .
 .TP
-.B The same, but with libavcodec family, MJPEG compression
+.B The same, but with MJPEG compression
 mencoder dvd://2 \-o titel2.avi \-ovc lavc
-\-lavcopts vcodec=mjpeg:vhq:vbitrate=1800 \-oac copy
+\-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800 \-oac copy
 .
 .TP
-.B Encoding all *.jpg files in the current dir
+.B Encode all *.jpg files in the current dir:
 mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
 .
 .TP
-.B Encoding from tuner (specify a format with \-vf format)
+.B Encode from a tuner (specify a format with \-vf format):
 mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
 .
 .TP
-.B Encoding from a pipe
+.B Encode from a pipe:
 rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
 .
 .