From d62943e7a2d02fe7619b2713d1d681bca12c9bf0 Mon Sep 17 00:00:00 2001 From: diego Date: Tue, 30 Oct 2007 17:09:46 +0000 Subject: Consistently use \- in option names. In roff '-' is used for hyphens while '\-' is used for minus and en/em-dashes. git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@24897 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/man/en/mplayer.1 | 210 +++++++++++++++++++++++++------------------------- 1 file changed, 105 insertions(+), 105 deletions(-) (limited to 'DOCS/man/en') diff --git a/DOCS/man/en/mplayer.1 b/DOCS/man/en/mplayer.1 index 1571705fbb..a238733d09 100644 --- a/DOCS/man/en/mplayer.1 +++ b/DOCS/man/en/mplayer.1 @@ -521,7 +521,7 @@ If you wish to have a configuration file for a file called 'movie.avi', create a named 'movie.avi.conf' with the file-specific options in it and put it in ~/.mplayer/. You can also put the configuration file in the same directory as the file to -be played, as long as you give the \-use-filedir-conf option (either on the +be played, as long as you give the \-use\-filedir\-conf option (either on the command line or in your global config file). .PP .I EXAMPLE MPLAYER CONFIGURATION FILE: @@ -600,7 +600,7 @@ lavcopts=mbd=2:trell=yes:v4mv=yes .SH "GENERAL OPTIONS" . .TP -.B \-codecs-file (also see \-afm, \-ac, \-vfm, \-vc) +.B \-codecs\-file (also see \-afm, \-ac, \-vfm, \-vc) Override the standard search path and use the specified file instead of the builtin codecs.conf. . @@ -609,7 +609,7 @@ instead of the builtin codecs.conf. Specify configuration file to be parsed after the default ones. . .TP -.B \-list-options +.B \-list\-options Prints all available options. . .TP @@ -690,16 +690,16 @@ Using realtime priority can cause system lockup. Use the given profile(s), \-profile help displays a list of the defined profiles. . .TP -.B \-really-quiet (also see \-quiet) +.B \-really\-quiet (also see \-quiet) Display even less output and status messages than with \-quiet. Also suppresses the GUI error message boxes. . .TP -.B \-show-profile +.B \-show\-profile Show the description and content of a profile. . .TP -.B \-use-filedir-conf +.B \-use\-filedir\-conf Look for a file-specific configuration file in the same directory as the file that is being played. .br @@ -766,22 +766,22 @@ xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output drivers. . .TP -.B \-correct-pts (experimental) +.B \-correct\-pts (experimental) Switches MPlayer to an experimental mode where timestamps for video frames are calculated differently and video filters which add new frames or modify timestamps of existing ones are supported. The more accurate timestamps can be visible for example when playing subtitles timed to scene changes with the \-ass option. -Without \-correct-pts the subtitle timing will typically be off by some frames. +Without \-correct\-pts the subtitle timing will typically be off by some frames. This option does not work correctly with some demuxers and codecs. . .TP -.B \-crash-debug (DEBUG CODE) +.B \-crash\-debug (DEBUG CODE) Automatically attaches gdb upon crash or SIGTRAP. -Support must be compiled in by configuring with \-\-enable-crash-debug. +Support must be compiled in by configuring with \-\-enable\-crash\-debug. . .TP -.B \-doubleclick-time +.B \-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 @@ -805,7 +805,7 @@ Enqueue files given on the command line in the playlist instead of playing them immediately. . .TP -.B \-fixed-vo +.B \-fixed\-vo Enforces a fixed video system for multiple files (one (un)initialization for all files). Therefore only one window will be opened for all files. @@ -888,7 +888,7 @@ several 'echo "seek 10" > mp_pipe' and the pipe will stay valid. .PD 1 . .TP -.B \-key-fifo-size <2\-65000> +.B \-key\-fifo\-size <2\-65000> Specify the size of the FIFO that buffers key events (default: 7). A FIFO of size n can buffer (n-1) events. If it is too small some events may be lost @@ -903,7 +903,7 @@ set it to 2 for Linux or 1024 for Windows. Specifies a configuration file for LIRC (default: ~/.lircrc). . .TP -.B \-list-properties +.B \-list\-properties Print a list of the available properties. . .TP @@ -916,36 +916,36 @@ Loops movie playback times. Turn on OSD menu support. . .TP -.B \-menu-cfg (OSD menu only) +.B \-menu\-cfg (OSD menu only) Use an alternative menu.conf. . .TP -.B \-menu-chroot (OSD menu only) +.B \-menu\-chroot (OSD menu only) Chroot the file selection menu to a specific location. .sp 1 .I EXAMPLE: .PD 0 .RSs -.IPs "\-menu-chroot=/home" +.IPs "\-menu\-chroot=/home" Will restrict the file selection menu to /\:home and downward (i.e.\& no access to / will be possible, but /home/user_name will). .RE .PD 1 . .TP -.B \-menu-keepdir (OSD menu only) +.B \-menu\-keepdir (OSD menu only) File browser starts from the last known location instead of current directory. . .TP -.B \-menu-root (OSD menu only) +.B \-menu\-root (OSD menu only) Specify the main menu. . .TP -.B \-menu-startup (OSD menu only) +.B \-menu\-startup (OSD menu only) Display the main menu at MPlayer startup. . .TP -.B \-mouse-movements +.B \-mouse\-movements Permit MPlayer to receive pointer events reported by the video output driver (currently only derivatives of X11 are supported). Necessary to select the buttons in DVD menus. @@ -982,7 +982,7 @@ Useless with modern Linux kernels configured for desktop use as they already wake up the process with similar accuracy when using normal timed sleep. . .TP -.B \-playing-msg +.B \-playing\-msg Print out a string before starting playback. The following expansions are supported: .RSs @@ -1004,7 +1004,7 @@ only to the elements of this playlist. FIXME: This needs to be clarified and documented thoroughly. . .TP -.B \-rtc-device +.B \-rtc\-device Use the specified device for RTC timing. . .TP @@ -1089,13 +1089,13 @@ Plays a Matroska file in Japanese. .PD 1 . .TP -.B \-audio-demuxer <[+]name> (\-audiofile only) +.B \-audio\-demuxer <[+]name> (\-audiofile only) Force audio demuxer type for \-audiofile. Use a '+' before the name to force it, this will skip some checks! -Give the demuxer name as printed by \-audio-demuxer help. +Give the demuxer name as printed by \-audio\-demuxer help. For backward compatibility it also accepts the demuxer ID as defined in libmpdemux/\:demuxer.h. -\-audio-demuxer audio or \-audio-demuxer 17 forces MP3. +\-audio\-demuxer audio or \-audio\-demuxer 17 forces MP3. . .TP .B \-audiofile @@ -1103,12 +1103,12 @@ Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a movie. . .TP -.B \-audiofile-cache +.B \-audiofile\-cache Enables caching for the stream used by \-audiofile, using the specified amount of memory. . .TP -.B \-reuse-socket (udp:// only) +.B \-reuse\-socket (udp:// only) Allows a socket to be reused by other processes as soon as it is closed. . .TP @@ -1130,12 +1130,12 @@ Especially useful on slow media. Turns off caching. . .TP -.B \-cache-min +.B \-cache\-min Playback will start when the cache has been filled up to of the total. . .TP -.B \-cache-seek-min +.B \-cache\-seek\-min If a seek is to be made to a position within of the cache size from the current position, MPlayer will wait for the cache to be filled to this position rather than performing a stream seek (default: 50). @@ -1176,7 +1176,7 @@ May be negative. .RE . .TP -.B \-cdrom-device +.B \-cdrom\-device Specify the CD-ROM device (default: /dev/\:cdrom). . .TP @@ -1218,7 +1218,7 @@ Optionally specify which chapter to end playing at (default: 1). Send cookies when making HTTP requests. . .TP -.B \-cookies-file (network only) +.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. @@ -1228,19 +1228,19 @@ The file is assumed to be in Netscape format. audio delay in seconds (positive or negative float value) .br Negative values delay the audio, and positive values delay the video. -Note that this is the exact opposite of the \-audio-delay MEncoder option. +Note that this is the exact opposite of the \-audio\-delay MEncoder option. .br .I NOTE: When used with MEncoder, this is not guaranteed to work correctly -with \-ovc copy; use \-audio-delay instead. +with \-ovc copy; use \-audio\-delay instead. . .TP -.B \-ignore-start +.B \-ignore\-start Ignore the specified starting time for streams in AVI files. In MPlayer, this nullifies stream delays in files encoded with -the \-audio-delay option. +the \-audio\-delay option. During encoding, this option prevents MEncoder from transferring -original stream start times to the new file; the \-audio-delay option is +original stream start times to the new file; the \-audio\-delay option is not affected. Note that MEncoder sometimes adjusts stream starting times automatically to compensate for anticipated decoding delays, so do not @@ -1299,7 +1299,7 @@ frequency before giving up (default: 30). .PD 1 . .TP -.B \-dvd-device (DVD only) +.B \-dvd\-device (DVD only) Specify the DVD device (default: /dev/\:dvd). You can also specify a directory that contains files previously copied directly from a DVD (with e.g.\& vobcopy). @@ -1307,14 +1307,14 @@ Note that using \-dumpstream is usually a better way to copy DVD titles in the first place (see the examples). . .TP -.B \-dvd-speed (DVD only) +.B \-dvd\-speed (DVD only) Try to limit DVD speed (default: 0, no change). DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to 10800KB/s. Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be quiet and fast enough. MPlayer resets the speed to the drive default value on close. -Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd-speed 8 selects +Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd\-speed 8 selects 10800KB/s. .br .I NOTE: @@ -1378,7 +1378,7 @@ Useful if the original value is wrong or missing. Play/\:convert only first frames, then quit. . .TP -.B \-hr-mp3-seek (MP3 only) +.B \-hr\-mp3-seek (MP3 only) Hi-res MP3 seeking. Enabled when playing from an external MP3 file, as we need to seek to the very exact position to keep A/V sync. @@ -1461,12 +1461,12 @@ Always falls back on content-based demuxer selection. Specify password for HTTP authentication. . .TP -.B \-prefer-ipv4 (network only) +.B \-prefer\-ipv4 (network only) Use IPv4 on network connections. Falls back on IPv6 automatically. . .TP -.B \-prefer-ipv6 (IPv6 network only) +.B \-prefer\-ipv6 (IPv6 network only) Use IPv6 on network connections. Falls back on IPv4 automatically. . @@ -1661,13 +1661,13 @@ Play a raw YUV sample. .PD 1 . .TP -.B \-rtsp-port +.B \-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. . .TP -.B \-rtsp-destination +.B \-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. @@ -1676,7 +1676,7 @@ which IP address MPlayer tries to bind to and try to force it to one assigned to your computer instead. . .TP -.B \-rtsp-stream-over-tcp (LIVE555 and NEMESI only) +.B \-rtsp\-stream\-over\-tcp (LIVE555 and NEMESI only) Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP 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 @@ -1707,7 +1707,7 @@ Selects the output sample rate to be used If the sample frequency selected is different from that of the current media, the resample or lavcresample audio filter will be inserted into the audio filter layer to compensate for the difference. -The type of resampling can be controlled by the \-af-adv option. +The type of resampling can be controlled by the \-af\-adv option. The default is fast resampling that may cause distortion. . .TP @@ -1956,7 +1956,7 @@ currently scanning channel is active. Specify username for HTTP authentication. . .TP -.B \-user-agent +.B \-user\-agent Use as user agent for HTTP streaming. . .TP @@ -1984,37 +1984,37 @@ external subtitles and Matroska tracks. You may also want to use \-embeddedfonts. . .TP -.B \-ass-border-color +.B \-ass\-border\-color Sets the border (outline) color for text subtitles. The color format is RRGGBBAA. . .TP -.B \-ass-bottom-margin +.B \-ass\-bottom\-margin Adds a black band at the bottom of the frame. -The SSA/ASS renderer can place subtitles there (with \-ass-use-margins). +The SSA/ASS renderer can place subtitles there (with \-ass\-use\-margins). . .TP -.B \-ass-color +.B \-ass\-color Sets the color for text subtitles. The color format is RRGGBBAA. . .TP -.B \-ass-font-scale +.B \-ass\-font\-scale Set the scale coefficient to be used for fonts in the SSA/ASS renderer. . .TP -.B \-ass-force-style <[Style.]Param=Value[,...]> +.B \-ass\-force\-style <[Style.]Param=Value[,...]> Override some style parameters. .sp .I EXAMPLE: .PD 0 .RSs -\-ass-force-style FontName=Arial,Default.Bold=1 +\-ass\-force\-style FontName=Arial,Default.Bold=1 .RE .PD 1 . .TP -.B \-ass-hinting +.B \-ass\-hinting Set hinting type. .PD 0 .RSs @@ -2035,23 +2035,23 @@ The default value is 7 (use native hinter for unscaled OSD and no hinting otherw .PD 1 . .TP -.B \-ass-line-spacing +.B \-ass\-line\-spacing Set line spacing value for SSA/ASS renderer. . .TP -.B \-ass-styles +.B \-ass\-styles Load all SSA/ASS styles found in the specified file and use them for rendering text subtitles. The syntax of the file is exactly like the [V4 Styles] / [V4+ Styles] section of SSA/ASS. . .TP -.B \-ass-top-margin +.B \-ass\-top\-margin Adds a black band at the top of the frame. -The SSA/ASS renderer can place toptitles there (with \-ass-use-margins). +The SSA/ASS renderer can place toptitles there (with \-ass\-use\-margins). . .TP -.B \-ass-use-margins +.B \-ass\-use\-margins Enables placing toptitles and subtitles in black borders when they are available. . @@ -2126,11 +2126,11 @@ bold black outline .PD 1 . .TP -.B \-flip-hebrew (FriBiDi only) +.B \-flip\-hebrew (FriBiDi only) Turns on flipping subtitles using FriBiDi. . .TP -.B \-noflip-hebrew-commas +.B \-noflip\-hebrew\-commas 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. @@ -2166,7 +2166,7 @@ Display only forced subtitles for the DVD subtitle stream selected by e.g.\& \-slang. . .TP -.B \-fribidi-charset (FriBiDi only) +.B \-fribidi\-charset (FriBiDi only) Specifies the character set that will be passed to FriBiDi when decoding non-UTF-8 subtitles (default: ISO8859-8). . @@ -2180,7 +2180,7 @@ subtitles. Turns off automatic subtitle file loading. . .TP -.B \-osd-duration