# HG changeset patch # User diego # Date 1093714532 0 # Node ID 09b0bfb42d6d186e73bdc0843cfa0c6bbcae3221 # Parent ab47adda958a5b08d94554bcf3a9db5e9780cb75 Consistently insert lines with only "." between options. Greatly improves readability. diff -r ab47adda958a -r 09b0bfb42d6d DOCS/man/en/mplayer.1 --- a/DOCS/man/en/mplayer.1 Sat Aug 28 17:25:30 2004 +0000 +++ b/DOCS/man/en/mplayer.1 Sat Aug 28 17:35:32 2004 +0000 @@ -49,12 +49,14 @@ .nh .B mplayer .RI [options]\ [ \ file\ | \ URL\ | \ playlist\ | \ \-\ ] +. .br .B mplayer 'in +\n[.k]u [global options] .I file1 [specific options] [file2] [specific options] +. .br .in .B mplayer @@ -62,70 +64,82 @@ [global options] .RI { "group of files and options" } [group specific options] +. .br .in .B mplayer 'in +\n[.k]u .I dvd://[title | [start_title]\-end_title ] [options] +. .br .in .B mplayer 'in +\n[.k]u .I vcd://track[/device] +. .br .in .B mplayer 'in +\n[.k]u .I tv://[channel] [options] +. .br .in .B mplayer 'in +\n[.k]u .I dvb://[card_number@]channel [options] +. .br .in .B mplayer 'in +\n[.k]u .I mf://filemask [-mf options] [options] +. .br .in .B mplayer 'in +\n[.k]u .I [cdda|cddb]://track[:speed][/device] [options] +. .br .in .B mplayer 'in +\n[.k]u .I cue://file[:track] [options] +. .br .in .B mplayer 'in +\n[.k]u .RI [ mms[t] | http | http_proxy | rt[s]p | ftp ] :// [user:passwd@]\fIURL\fP[:port] [options] +. .br .in .B mplayer 'in +\n[.k]u .I sdp://file [options] +. .br .in .B mplayer 'in +\n[.k]u .I mpst://host[:port]/URL [options] +. .br .in .B gmplayer [options] [\-skin\ skin] +. .br .B mencoder [options] @@ -193,6 +207,7 @@ The default configuration file for the input system is ~/.mplayer/\:input.conf but it can be overriden using the \-input option. +. .TP .B general control .PD 0 @@ -340,24 +355,28 @@ ~/.mplayer or in the same directory as the file. . . +. .SH "GENERAL OPTIONS" +. .TP .B \-codecs-file Use the specified file instead of system wide installed or builtin codecs.conf. See also \-afm, \-ac, \-vfm and \-vc. +. .TP .B \-include Specify configuration file to be parsed after the default ones. +. .TP .B \-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). +. .TP .B \-v, \-verbose Increment verbose level (more \-v means more verbosity). -. .PD 0 .RSs .IPs 0 @@ -374,6 +393,7 @@ . . .SH "PLAYER OPTIONS (MPLAYER ONLY)" +. .TP .B \-autoq (use with \-vf [s]pp) Dynamically changes the level of postprocessing depending on the available spare @@ -381,6 +401,7 @@ The number you specify will be the maximum level used. Usually you can use some big number. You have to use \-vf [s]pp without parameters in order for this to work. +. .TP .B \-autosync Gradually adjusts the A/\:V sync based on audio delay measurements. @@ -397,6 +418,7 @@ 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 of playback. @@ -406,23 +428,27 @@ .I NOTE: With this option MPlayer will also ignore frame duration when playing only video (you can think of that as infinite fps). +. .TP .B \-colorkey Changes the colorkey to an RGB value of your choice. 0x000000 is black and 0xffffff is white. Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix and xover video out drivers. +. .TP .B \-nocolorkey Disables colorkeying. Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix and xover video out drivers. +. .TP .B \-edl (EDL only) Enables edit decision list (EDL) actions during playback. Video will be skipped over and audio will be muted and unmuted according to the entries in the given file. See DOCS/\:HTML/\:en/\:edl.html for details on how to use this. +. .TP .B \-edlout (EDL only) Creates a new file and writes edit decision list (EDL) records to that file. @@ -431,10 +457,12 @@ This provides a starting point from which the user can fine-tune EDL entries later. See DOCS/\:HTML/\:en/\:edl.html for details. +. .TP .B \-enqueue (GUI only) Enqueue files given on the command line in the playlist instead of playing them immediately. +. .TP .B \-fixed-vo (BETA CODE!) Enforces a fixed video system for multiple files (one (un)initialisation for @@ -442,23 +470,28 @@ Therefore only one window will be opened for all files. Currently the following drivers are fixed-vo compliant: gl2, mga, svga, x11, xmga, xv, xvidix and dfbmga. +. .TP .B \-framedrop (also see \-hardframedrop) 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 skipped completely. +. .TP .B \-h, \-help, \-\-help Show short summary of options. +. .TP .B \-hardframedrop More intense frame dropping (breaks decoding). Leads to image distortion! +. .TP .B \-identify Show file parameters in an easily parseable format. The wrapper script TOOLS/\:midentify suppresses the other MPlayer output and (hopefully) shellescapes the filenames. +. .TP .B \-input This option can be used to configure certain parts of the input system. @@ -497,22 +530,28 @@ .TP .B \-lircconf (LIRC only) Specifies a configuration file for LIRC (default: ~/\:.lircrc). +. .TP .B \-list-options Prints out all the available options. +. .TP .B \-loop Loops movie playback times. 0 means forever. +. .TP .B \-menu (OSD menu only) Turn on OSD menu support. +. .TP .B \-menu-cfg (OSD menu only) Use an alternative menu.conf. +. .TP .B \-menu-root (OSD menu only) Specify the main menu. +. .TP .B \-noconsolecontrols Prevent MPlayer from reading key events from standard input. @@ -522,20 +561,25 @@ if you open /dev/\:stdin (or the equivalent on your system), use stdin in a playlist or intend to read from stdin later on via the loadfile or loadlist slave commands. +. .TP .B \-nojoystick Turns off joystick support. +. .TP .B \-nolirc Turns off LIRC support. +. .TP .B \-nomouseinput (X11 only) Disable mouse button press/\:release input (mozplayerxp's context menu relies on this option). +. .TP .B \-nortc (RTC only) Turns off usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing mechanism. +. .TP .B \-playlist Play files according to a playlist file (ASX, Winamp, SMIL, or @@ -546,15 +590,19 @@ only to the elements of this playlist. .br FIXME: This needs to be clarified and documented thoroughly. +. .TP .B \-really-quiet (also see \-quiet) Display even less output and status messages than with \-quiet. +. .TP .B \-rtc-device Use the specified device for RTC timing. +. .TP .B \-shuffle Play files in random order. +. .TP .B \-skin (GUI only) Loads a skin from the directory given as parameter below the default skin @@ -576,21 +624,26 @@ .br .I NOTE: See DOCS/\:tech/\:slave.txt and \-input cmdlist for a list of slave commands. +. .TP .B \-softsleep Use high-quality software timers instead of the RTC. As precise as the RTC without requiring special privileges. Comes at the price of higher CPU consumption. +. .TP .B \-speed <0.01\-100> Slow down or speed up playback by the factor given as parameter. +. .TP .B \-sstep Display one frame every seconds. Useful for slideshows. . . +. .SH "DEMUXER/\:STREAM OPTIONS" +. .TP .B \-a52drc Select the Dynamic Range Compression level for AC3 audio streams. @@ -599,6 +652,7 @@ silent and vice versa). This option only shows an effect if the AC3 stream contains the required range compression information. +. .TP .B \-aid (also see \-alang) Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127, @@ -606,6 +660,7 @@ MPlayer prints the available IDs when run in verbose (\-v) mode. When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program (if present) with the chosen audio stream. +. .TP .B \-alang (also see \-aid) (DVD only) Selects the DVD audio language and tries to play audio streams whose @@ -625,41 +680,48 @@ Force audio demuxer type for \-audiofile. Give the demuxer ID as defined in libmpdemux/\:demuxer.h. \-audio-demuxer 17 forces MP3. +. .TP .B \-audiofile Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a movie. +. .TP .B \-audiofile-cache Enables caching for the stream used by \-audiofile, using the specified amount of memory. +. .TP .B \-bandwidth (network only) Specify the maximum bandwidth for network streaming (for servers that are able to send content in different bitrates). Useful if you want to watch live streamed media behind a slow connection. +. .TP .B \-cdrom-device Specify the CD-ROM device (default: /dev/\:cdrom). +. .TP .B \-cache This option specifies how much memory (in kBytes) to use when precaching a file or URL. Especially useful on slow media. +. .TP .B \-cache-min Playback will start when the cache fill threshold set with this option is reached. +. .TP .B \-cache-prefill (not yet implemented) When the cache is emptied MPlayer will pause and restart playback when the cache prefill threshold set with this option is reached. +. .TP .B \-cdda (CDDA only) This option can be used to tune the CD Audio reading feature of MPlayer. .sp 1 Available options are: -. .RSs .IPs speed= Set CD spin speed. @@ -727,33 +789,41 @@ .B \-chapter [\-] (DVD only) Specify which chapter to start playing at. Optionally specify which chapter to end playing at (default: 1). +. .TP .B \-cookies (network only) Send cookies when making HTTP requests. +. .TP .B \-cookies-file (network only) Read HTTP cookies from (default: ~/.mozilla/ and ~/.netscape/) and skip reading from default locations. The file is assumed to be in Netscape format. +. .TP .B \-demuxer Force demuxer type. Give the demuxer ID as defined in libmpdemux/\:demuxer.h. \-demuxer 17 forces MP3. +. .TP .B \-dumpaudio (MPlayer only) 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. +. .TP .B \-dumpstream (MPlayer only) 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). +. .TP .B \-dvbin (DVB only) Pass the following parameters to the DVB input module, in order to override @@ -773,10 +843,12 @@ .TP .B \-dvd-device (DVD only) Specify the DVD device (default: /dev/\:dvd). +. .TP .B \-dvdangle (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). +. .TP .B \-forceidx Force index rebuilding. @@ -787,13 +859,16 @@ .I NOTE: This option only works if the underlying media supports seeking (i.e.\& not with stdin, pipe, etc). +. .TP .B \-fps Override video framerate. Useful if the original value is wrong or missing. +. .TP .B \-frames Play/\:convert only first frames, then quit. +. .TP .B \-hr-mp3-seek (MP3 only) Hi-res MP3 seeking. @@ -801,6 +876,7 @@ to the very exact position to keep A/\:V sync. Can be slow especially when seeking backwards since it has to rewind to the beginning to find an exact frame position. +. .TP .B \-idx (also see \-forceidx) Rebuilds index of files if no index was found, allowing seeking. @@ -809,10 +885,12 @@ .I NOTE: This option only works if the underlying media supports seeking (i.e.\& not with stdin, pipe, etc). +. .TP .B \-ipv4-only-proxy (network only) Skip the proxy for IPv6 addresses. It will still be used for IPv4 connections. +. .TP .B \-loadidx The file from which to read the video index data saved by \-saveidx. @@ -823,9 +901,11 @@ .br .I NOTE: This option is obsolete now that MPlayer has OpenDML support. +. .TP .B \-mc maximum A-V sync correction per frame (in seconds) +. .TP .B \-mf Used when decoding from multiple PNG or JPEG files. @@ -849,10 +929,12 @@ .B \-ni (AVI only) Force usage of non-interleaved AVI parser (fixes playback of some bad AVI files). +. .TP .B \-nobps (AVI only) Do not use average byte/\:second value for A-V sync. Helps with some AVI files with broken header. +. .TP .B \-noextbased Disables extension-based demuxer selection. @@ -860,17 +942,21 @@ (the file has no header or it is not reliable enough), the filename extension is used to select the demuxer. Always falls back to content-based demuxer selection. +. .TP .B \-passwd (see \-user option too) (network only) Specify password for HTTP authentication. +. .TP .B \-prefer-ipv4 (network only) Use IPv4 on network connections. Falls back to IPv6 automatically. +. .TP .B \-prefer-ipv6 (IPv6 network only) Use IPv6 on network connections. Falls back to IPv4 automatically. +. .TP .B \-rawaudio This option lets you play raw audio files. @@ -929,6 +1015,7 @@ packets be streamed over TCP (using the same TCP connection as RTSP). This option may be useful if you have a broken internet connection that does not pass incoming UDP packets (see http://www.live.com/\:mplayer/). +. .TP .B \-saveidx Force index rebuilding and dump the index to . @@ -936,14 +1023,17 @@ .br .I NOTE: This option is obsolete now that MPlayer has OpenDML support. +. .TP .B \-sb (see \-ss option too) Seek to byte position. Useful for playback from CD-ROM images or VOB files with junk at the beginning. +. .TP .B \-srate Selects the given output sampling rate, resampling if necessary. MEncoder passes this value to LAME for resampling. +. .TP .B \-ss