# HG changeset patch # User jonas # Date 1034633438 0 # Node ID 99aba45167f5e21c27decb003efdffad465854bc # Parent 5b8df1d63b6d106c60036c46fa93a1761e05e96c rewrite (again ;), cosmetics, no real changes diff -r 5b8df1d63b6d -r 99aba45167f5 DOCS/mplayer.1 --- a/DOCS/mplayer.1 Mon Oct 14 20:51:18 2002 +0000 +++ b/DOCS/mplayer.1 Mon Oct 14 22:10:38 2002 +0000 @@ -1,9 +1,10 @@ .\" MPlayer (C) 2000-2002 Arpad Gereoffy .\" This man page was/is done by Gabucino, Diego Biurrun, Jonas Jermann .\" -.\" Run groff -m man -Thtml mplayer.1 > manpage.html for a html version -.\" Run groff -m man -Tascii mplayer.1 | col -bx > manpage.txt for a text -.\" version +.\" Run this to get a html version of the man page: +.\" cat mplayer.1 | sed s/SS\ 20/SS\ 4/ | groff -man -Thtml - > manpage.html +.\" Run this to get a text version of the man page: +.\" groff -m man -Tascii mplayer.1 | col -bx > manpage.txt .\" . .\" -------------------------------------------------------------------------- @@ -12,10 +13,8 @@ . .\" default indentation is 7, don't change! .nr IN 7 -.. .\" define indentation for suboptions .nr SS 20 -.. .\" add new suboption .de IPs .IP "\\$1" \n(SS @@ -51,29 +50,47 @@ .\" -------------------------------------------------------------------------- . .SH SYNOPSIS +.na +.nh .B mplayer .RI [options]\ [ \ file\ | \ URL\ | \ playlist\ | \ -\ ] .br .B mplayer -.RI [global\ options] \ file1\ [specific\ options]\ [file2]\ \ -[specific\ options] +'in +\n[.k]u +[global options] +.I file1 +[specific options] [file2] [specific options] .br +.in .B mplayer -.RI [global\ options]\ { group\ of\ files\ and\ options }\ \ -[group\ specific\ options] +'in +\n[.k]u +[global options] +.RI { "group of files and options" } +[group specific options] .br +.in .B mplayer -.RI [ dvd | vcd | cdda | cddb | tv ] ://title\ [options] -.br -.B mplayer -.RI [ mms[t] | http | http_proxy | rt[s]p | smb ] :// [user:passwd@] URL [:port]\ \ +'in +\n[.k]u +.RI [ dvd | vcd | cdda | cddb | tv ] ://title [options] .br +.in +.B mplayer +'in +\n[.k]u +.RI [ mms[t] | http | http_proxy | rt[s]p | smb ] :// [user:passwd@] URL +[:port] [options] +.br +.in .B mencoder -.RI [options]\ [ \ file\ | \ URL\ | \ -\ ]\ [\-o\ file] +[options] +.RI [ \ file\ | \ URL\ | \ -\ ] +[\-o\ file] .br .B gmplayer -.RI [options]\ [\-skin\ skin] +[options] +[\-skin\ skin] +.ad +.hy .\" -------------------------------------------------------------------------- .\" Description @@ -81,37 +98,40 @@ . .SH DESCRIPTION .B mplayer -is a movie player for LINUX (runs on many other Unices and non\-x86 -CPUs, see the documentation). It plays most MPEG/VOB, AVI, ASF/WMA/WMV, RM, -QT/MOV/MP4, OGG/OGM, VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, -supported by many native, XAnim, and Win32 DLL codecs. You can watch VideoCD, -SVCD, DVD, 3ivx, DivX 3/4/5 and even WMV movies, too (without the avifile -library). +is a movie player for LINUX (runs on many other Unices and non\-x86 CPUs, see +the documentation). +It plays most MPEG/\:VOB, AVI, ASF/\:WMA/\:WMV, RM, QT/\:MOV/\:MP4, OGG/\:OGM, +VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, supported by many +native, XAnim, and Win32 DLL codecs. +You can watch VideoCD, SVCD, DVD, 3ivx, DivX\ 3/\:4/\:5 and even WMV movies, +too (without the avifile library). .PP Another great feature of MPlayer is the wide range of supported output -drivers. It works with X11, XV, DGA, OpenGL, SVGAlib, fbdev, AAlib, DirectFB, -but you can also use GGI, SDL (and this way all their drivers), VESA (on every -VESA compatible card, even without X11!), some low level card-specific drivers -(for Matrox, 3Dfx and ATI) and some hardware MPEG decoder boards, such as the -Siemens DVB, DXR2 and DXR3/Hollywood+. -.br +drivers. +It works with X11, XV, DGA, OpenGL, SVGAlib, fbdev, AAlib, DirectFB, but you +can also use GGI, SDL (and this way all their drivers), VESA (on every VESA +compatible card, even without X11), some low level card-specific drivers (for +Matrox, 3Dfx and ATI) and some hardware MPEG decoder boards, such as the +Siemens DVB, DXR2 and DXR3/\:Hollywood+. Most of them support software or hardware scaling, so you can enjoy movies in fullscreen. .PP MPlayer has an onscreen display (OSD) for status information, nice big antialiased shaded subtitles and visual feedback for keyboard controls. -European/ISO 8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean +European/\:ISO 8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean fonts are supported along with 9 subtitle formats (MicroDVD, SubRip, SubViewer, Sami, VPlayer, RT, SSA, AQTitle and our own: MPsub) and DVD subtitles (SPU streams, VobSub and Closed Captions). .PP .B mencoder -(MPlayer's Movie Encoder) is a simple movie encoder, designed to -encode MPlayer-playable movies (see above) to other MPlayer-playable formats -(see below). It encodes to DivX4, XviD, one of the libavcodec codecs and -PCM/MP3/VBRMP3 audio in 1, 2 or 3 passes. Furthermore it has stream copying -abilities, a powerful plugin system (crop, expand, flip, postprocess, rotate, -scale, noise, rgb/yuv conversion) and more. +(MPlayer's Movie Encoder) is a simple movie encoder, designed to encode +MPlayer-playable movies (see above) to other MPlayer-playable formats (see +below). +It encodes to DivX4, XviD, one of the libavcodec codecs and PCM/\:MP3/\:VBRMP3 +audio in 1, 2 or 3\ passes. +Furthermore it has stream copying abilities, a powerful plugin system (crop, +expand, flip, postprocess, rotate, scale, noise, rgb/\:yuv conversion) and +more. .PP .B gmplayer is MPlayer with a graphical user interface. @@ -122,78 +142,81 @@ .\" Options .\" -------------------------------------------------------------------------- . -.SH GENERAL NOTES +.SH "GENERAL NOTES" .B Also see the HTML documentation! - -Every "flag" option has a "noflag" counterpart, e.g. the opposite of the \-fs -option is \-nofs. -.br -You can put all of the options in a config file which will be read every time -mplayer is run. The system-wide config file 'mplayer.conf' is in your -configuration directory (e.g. /etc/mplayer or /usr/local/etc/mplayer), the -user specific one is '~/.mplayer/config'. User specific options override -system\-wide options and options given on the command line override either. -The syntax of the config files is 'option=', everything after a '#' is -considered a comment. Options that work without values can be enabled by -setting them to 'yes' or '1' and disabled by setting them to 'no' or '0'. +.PP +Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the +\-fs option is \-nofs. +.PP +You can put all of the options in a configuration file which will be read +every time mplayer is run. +The system-wide configuration file 'mplayer.conf' is in your configuration +directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user +specific one is '~/\:.mplayer/\:config'. +User specific options override system\-wide options and options given on the +command line override either. +The syntax of the configuration files is 'option=', everything after a +\'#' is considered a comment. +Options that work without values can be enabled by setting them to 'yes' or +\'1' and disabled by setting them to 'no' or '0'. Even suboptions can be specified in this way. +.nf .I EXAMPLE: -.br # Use Matrox driver by default. -.br vo=xmga -.br # I love practicing handstands while watching videos. -.br flip=yes -.br -# Decode/encode multiple files from png, start it with -mf on -.br +# Decode/\:encode multiple files from png, start it with -mf on mf= type=png:fps=25 +.fi .SH "PLAYER OPTIONS (MPLAYER ONLY)" .TP -.B \-autoq (use with \-vop pp!) +.B \-autoq (use with \-vop pp) Dynamically changes the level of postprocessing depending on available spare -CPU time. The number you specify will be the maximum level used. Usually you -can use some big number. You may not use it together with \-pp but it is OK -with \-npp. +CPU time. +The number you specify will be the maximum level used. +Usually you can use some big number. +You may not use it together with \-pp but it is OK with \-npp. .TP .B \-autosync -Gradually adjusts the A/V sync based on audio delay measurements. -Specifying \-autosync 0, the default, will cause frame timing to be based -entirely on audio delay measurements. Specifying \-autosync 1 will do the -same, but will subtly change the A/V correction algorithm used. An uneven -video frame rate in a movie which plays fine with -nosound can often be -helped by setting this to an integer value greater than 1. The higher -the value, the closer the timing will be to -nosound. - -Try \-autosync 30 to smooth out problems with sound drivers which do -not implement a perfect audio delay measurement. With this value, if -large A/V sync offsets occur, they will only take about 1 or 2 seconds -to settle out. This delay in reaction time to sudden A/V offsets should -be the only side-effect of turning this option on, for all sound drivers. +Gradually adjusts the A/\:V sync based on audio delay measurements. +Specifying \-autosync\ 0, the default, will cause frame timing to be based +entirely on audio delay measurements. +Specifying \-autosync\ 1 will do the same, but will subtly change the A/\:V +correction algorithm used. +An uneven video frame rate in a movie which plays fine with \-nosound can +often be helped by setting this to an integer value greater than 1. +The higher the value, the closer the timing will be to -nosound. +.PP +Try \-autosync\ 30 to smooth out problems with sound drivers which do +not implement a perfect audio delay measurement. +With this value, if large A/\:V sync offsets occur, they will only take about +1 or 2\ seconds to settle out. +This delay in reaction time to sudden A/\:V offsets should be the only +side-effect of turning this option on, for all sound drivers. .TP .B \-benchmark Prints some statistics on CPU usage and dropped frames at the end. -Use in combination with \-nosound and \-vo null for benchmarking only the video -codec. +Use in combination with \-nosound and \-vo null for benchmarking only the +video codec. .TP .B \-framedrop (also see \-hardframedrop) -Skips displaying some frames to maintain A/V sync on slow systems. Decoding of -B frames is also skipped and video filters are not used. +Skips displaying some frames to maintain A/\:V sync on slow systems. +Decoding of B frames is also skipped and video filters are not used. .TP .B \-h, \-help, \-\-help Show short summary of options. .TP .B \-hardframedrop -More intense frame dropping (breaks decoding). Leads to image distortion! +More intense frame dropping (breaks decoding). +Leads to image distortion! .TP .B \-input This option can be used to configure certain parts of the input system. -Paths are relative to $HOME/.mplayer/. +Paths are relative to ~/\:.mplayer/. .I NOTE: .br @@ -204,8 +227,8 @@ .PD 0 .RSs .IPs conf= -Read alternative input.conf. If given without pathname, $HOME/.mplayer is -assumed. +Read alternative input.conf. +If given without pathname, ~/\:.mplayer is assumed. .IPs ar\-delay Delay in msec before we start to autorepeat a key (0 to disable). .IPs ar\-rate @@ -215,26 +238,28 @@ .IPs cmdlist Prints all commands that can be bound. .IPs js\-dev -Specifies the joystick device to use (default is /dev/input/js0). +Specifies the joystick device to use (default is /dev/\:input/\:js0). .RE .PD 1 . .TP -.B \-lircconf -Specifies a config file for LIRC (Linux Infrared Remote Control, see -http://www.lirc.org) if you don't like the default ~/.lircrc. +.B \-lircconf +Specifies a configuration file for LIRC (Linux Infrared Remote Control, see +http://www.lirc.org) if you don't like the default ~/\:.lircrc. .TP .B \-loop -Loops movie playback times. 0 means forever. +Loops movie playback times. +0 means forever. .TP .B \-nojoystick -Turns off joystick support. Default is on, if compiled in. +Turns off joystick support. +Default is on, if compiled in. .TP .B \-nolirc Turns off LIRC support. .TP .B \-nortc \ \ -Turns off usage of the Linux RTC (real-time clock \- /dev/rtc) as timing +Turns off usage of the Linux RTC (real-time clock \- /dev/\:rtc) as timing mechanism. .TP .B \-playlist @@ -250,33 +275,32 @@ .PD 0 .RSs .IPs "\-skin fittyfene" -tries these: -.RSss -/usr/local/share/mplayer/Skin/fittyfene -.br -~/.mplayer/Skin/fittyfene -.REss +tries /usr/\:local/\:share/\:mplayer/\:Skin/\:fittyfene first and +~/.mplayer/\:Skin/\:fittyfene afterwards .RE .PD 1 . .TP .B \-slave \ \ -This option switches on slave mode. This is intended for use -of MPlayer as a backend to other programs. Instead of intercepting keyboard -events, MPlayer will read simplistic command lines from its stdin. +This option switches on slave mode. +This is intended for use of MPlayer as a backend to other programs. +Instead of intercepting keyboard events, MPlayer will read simplistic command +lines from its stdin. The section .B SLAVE MODE PROTOCOL explains the syntax. .TP .B \-softsleep -Uses high quality software timers. As precise as the RTC without requiring -special privileges. Comes at the price of higher CPU consumption. +Uses high quality software timers. +As precise as the RTC without requiring special privileges. +Comes at the price of higher CPU consumption. .TP .B \-speed <0.01\-100> Set playback speed rate. .TP .B \-sstep -Specifies seconds between displayed frames. Useful for slideshows. +Specifies seconds between displayed frames. +Useful for slideshows. .TP .B \-use-stdin @@ -284,14 +308,16 @@ .SH "DEMUXER/STREAM OPTIONS" .TP .B \-aid (also see \-alang option) -Select audio channel [MPEG: 0\-31 AVI/OGM: 1\-99 ASF/RM: 0\-127 +Select audio channel [MPEG: 0\-31 AVI/\:OGM: 1\-99 ASF/\:RM: 0\-127 VOB(AC3): 128\-159 VOB(LPCM): 160\-191] MPlayer prints the available IDs when running in verbose (-v) mode. .TP .B \-alang (also see \-aid option) -Works only for DVD playback! Selects DVD audio language. It always tries -to play audio streams whose language matches the given code. For the list of -available languages, use with the \-v switch and look at the output. +Works only for DVD playback. +It selects the DVD audio language and always tries to play audio streams whose +language matches the given code. +For the list of available languages, use with the \-v switch and look at the +output. .I EXAMPLE: .PD 0 @@ -311,14 +337,16 @@ Play audio from an external file (WAV, MP3 or Ogg Vorbis). .TP .B \-cdrom\-device -Override default CDROM drive name /dev/cdrom. +Override default CDROM drive name /dev/\:cdrom. .TP .B \-cache This option specifies how much memory (in kbytes) to use when precaching a -file/URL. Especially useful on slow media (default is \-nocache). +file/\:URL. +Especially useful on slow media (default is \-nocache). .TP .B \-cdda This option can be used to tune the CD Audio reading feature of MPlayer. +.br Available options are: . .RSs @@ -327,11 +355,11 @@ .IPs paranoia=<0\-2> set paranoia level .RSss +.nf 0: disable checking -.br 1: overlap checking only (default) -.br 2: full data correction and verification +.fi .REss .IPs generic-dev= use specified generic SCSI device @@ -341,11 +369,11 @@ force minimum overlap search during verification to sectors. .IPs toc-bias Assume that the beginning offset of track 1 as reported in the TOC will be -addressed as LBA 0. Some Toshiba drives need this for getting track boundaries -correct. +addressed as LBA\ 0. +Some Toshiba drives need this for getting track boundaries correct. .IPs toc-offset= -Add sectors to the values reported when addressing tracks. May be -negative. +Add sectors to the values reported when addressing tracks. +May be negative. .IPs (no)skip (never) accept imperfect data reconstruction. .RE @@ -374,47 +402,49 @@ . .TP .B \-chapter [-] -Specify which chapter to start playing at. Optionally specify which chapter to -end playing at (default: 1). Examples can be found below. +Specify which chapter to start playing at. +Optionally specify which chapter to end playing at (default: 1). +Examples can be found below. .TP .B \-csslib (old-style DVD option) This option is used to override the default location of libcss.so. .TP .B \-demuxer -Force demuxer type. Give the demuxer ID as defined in demuxers.h. +Force demuxer type. +Give the demuxer ID as defined in demuxers.h. Use \-demuxer 17 to force .mp3 detection. .TP .B \-dumpaudio (MPLAYER only) -Dumps raw compressed audio stream to ./stream.dump (useful with mpeg/ac3). +Dumps raw compressed audio stream to ./\:stream.dump (useful with mpeg/\:ac3). .TP .B \-dumpfile (MPLAYER only) -Specify which file MPlayer should dump to. Should be used together -with \-dumpaudio/\-dumpvideo/\-dumpstream. +Specify which file MPlayer should dump to. +Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream. .TP .B \-dumpstream (MPLAYER only) -Dumps the raw stream to ./stream.dump. Useful when ripping from -DVD or network. +Dumps the raw stream to ./\:stream.dump. +Useful when ripping from DVD or network. .TP .B \-dumpvideo (MPLAYER only) -Dump raw compressed video stream to ./stream.dump (not very usable). +Dump raw compressed video stream to ./\:stream.dump (not very usable). .TP .B \-dvd -Tell MPlayer which movies (specified by title id) to play. For example -sometimes '1' is a trailer, and '2' is the real movie. +Tell MPlayer which movies (specified by title id) to play. +For example sometimes '1' is a trailer, and '2' is the real movie. .I NOTE: .br Sometimes deinterlacing is required for DVD playback, -see the \-pp 0x20000 or \-npp lb options. +see the \-pp 0x20000 or \-npp\ lb options. .TP .B \-dvd\-device -Override default DVD device name /dev/dvd. +Override default DVD device name /dev/\:dvd. .TP .B \-dvdangle Some DVD discs contain scenes that can be viewed from multiple angles. -Here you can tell MPlayer which angles to use (default: 1). Examples can be -found below. +Here you can tell MPlayer which angles to use (default: 1). +Examples can be found below. .TP .B \-dvdauth (old-style DVD option) Turns on DVD authentication using the given device. @@ -428,37 +458,41 @@ Force usage of libdvdnav. .TP .B \-forceidx -Force rebuilding of INDEX. Useful for files with broken index (desyncs, etc). -Seeking will be possible. You can fix the index permanently with -MEncoder (see the documentation). +Force rebuilding of INDEX. +Useful for files with broken index (desyncs, etc). +Seeking will be possible. +You can fix the index permanently with MEncoder (see the documentation). .TP .B \-fps -Override video framerate (if value is wrong/missing in the header) (float +Override video framerate (if value is wrong/\:missing in the header) (float number). .TP .B \-frames -Play/convert only first frames, then quit. +Play/\:convert only first frames, then quit. .TP .B \-hr\-mp3\-seek (.MP3 only) -Hi\-res mp3 seeking. Default is: enabled when playing from external MP3 file, -as we need to seek to the very exact position to keep A/V sync. It can be slow -especially when seeking backwards \- it has to rewind to the beginning to find -the exact frame. +Hi\-res mp3 seeking. +Default is: enabled when playing from external MP3 file, as we need to seek +to the very exact position to keep A/\:V sync.It can be slow especially when +seeking backwards \- it has to rewind to the beginning to find the exact +frame. .TP .B \-idx (also see \-forceidx) Rebuilds INDEX of the AVI if no INDEX was found, -thus allowing seeking. Useful with broken/incomplete -downloads, or badly created AVIs. +thus allowing seeking. +Useful with broken/\:incomplete downloads, or badly created AVIs. .TP .B \-mc Maximum A-V sync correction per frame (in seconds). .TP .B \-mf -Used when decoding from multiple PNG or JPEG files. Available options are: +Used when decoding from multiple PNG or JPEG files. +.br +Available options are: .PD 0 .RSs -.IPs on +.IPs on\ \ \ turns on multifile support .IPs w= width of the output (autodetect) @@ -477,20 +511,21 @@ of some bad AVI files). .TP .B \-nobps (.AVI only) -Do not use average byte/sec value for A\-V sync (AVI). +Do not use average byte/\:sec value for A\-V sync (AVI). Helps with some AVI files with broken header. .TP -.B \-passwd (see \-user option too!) +.B \-passwd (see \-user option too) Specify password for http authentication. .TP .B \-rawaudio -This option lets you play raw audio files. It may also be used to -play audio CDs which are not 44KHz 16Bit stereo. +This option lets you play raw audio files. +It may also be used to play audio CDs which are not 44KHz 16Bit stereo. +.br Available options are: .PD 0 .RSs -.IPs on +.IPs on\ \ \ use raw audio demuxer .IPs channels= number of channels @@ -507,15 +542,15 @@ .B \-skipopening Skip DVD opening (dvdnav only). .TP -.B \-sb (see \-ss option too!) -Seek to byte position. Useful for playback from CDROM -images / vob files with junk at the beginning. +.B \-sb (see \-ss option too) +Seek to byte position. +Useful for playback from CDROM images / .VOB files with junk at the beginning. .TP .B \-srate Forces the given audio playback rate, changing video speed to keep a-v sync. MEncoder passes this value to lame for resampling. .TP -.B \-ss