836 lines (813 with data), 26.8 kB
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.TH XINE 1x 2002-04-16 "The xine project"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
xine \- a free video player
.I "[options] [MRL] ..."
This manual page documents briefly the
plays MPEG system (audio and video) streams, mpeg elementary streams
(e.g. .mp3 or .mpv files), mpeg transport streams, ogg files,
avi files, asf files, quicktime files, (S)VCDs and DVDs and many more.
The programs follow the usual GNU command line syntax, with long
options starting with two dashes (`--').
A summary of options are included below.
For a complete description, see \fIREADME\fP and \fIFAQ\fP in \fI@XINE_DOCDIR@\fP
or on the xine home page.
.B \-h, \-\-help
Show summary of options and available output drivers (plugins).
.BI \-\-verbose [=level]
Set verbose level.
.BI \-\-config <file>
Use \fBconfig\fP file instead of default one.
.BI \-a,\ \-\-audio\-channel\ <num>
Select the given audio channel. \fI<num>\fP is the audio channel number, default
xine 0.5 and newer tries its best to collect all valid audio channels
(ac3, mpeg audio, avi audio, ...) from the stream and maps them
to "virtual channels" with channel numbers starting at \fB0\fP.
.BI \-V,\ \-\-video\-driver\ <drv>
Select video driver. Check out \fIxine\ \-\-help\fP for a list of available
video output plugins on your system. This selection is stored automatically
in your \fI~/.xine/config\fP so you'll have to specify the video driver only once.
.BI \-A,\ \-\-audio\-driver\ <drv>
Select audio driver. Check out \fIxine \-\-help\fP for a list of available
audio output plugins on your system. This selection is stored automatically
in your \fI~/.xine/config\fP so you'll have to specify the audio driver only once.
.BI \-u,\ \-\-spu\-channel\ <num>
Select subpicture (subtitle) channel. \fI<num>\fP is the subpicture channel
id, default is no subtitle (\fB\-1\fP).
.BI \-p,\ \-\-auto\-play= [f][F][h][w][q][d][v]
Start playing immediately after start. Can be followed by:
`\fIf\fP' in fullscreen mode,
`\fIF\fP' in xinerama fullscreen mode,
`\fIh\fP' hide GUI (main panel, etc...),
`\fIw\fP' hide video output window,
`\fIq\fP' for quitting after playback,
It is also possible to request the playlist from DVD `\fId\fP', or VCD `\fIv\fP'.
There is now a more generic option, \fI\-\-auto\-scan\fP, for that (see below).
.BI \-s,\ \-\-auto\-scan\ <plugin>
Auto-scan playlist from named input plugin. Many plugins allow to read a
default playlist, in order to play \fBeverything\fP. This works fine for DVDs
or VCDs, for example. Giving this option has the same effect as pressing
the according button on xine's main panel.
This option is especially useful in combination with auto-play. You could
start \fIxine\~\-\-auto\-play\~\-\-auto\-scan\~dvd\fP in order to play a whole DVD without
having to press any additional buttons. This also works for plugins that are
not supplied with xine, just give the name of the button that the desired
plugin adds to the xine panel!
.B \-f,\ \-\-fullscreen
Switch xine to fullscreen mode on start (just like pressing `\fBf\fP')
.B \-F,\ \-\-xineramafull
Switch xine to xinerama fullscreen mode on start (just like pressing `\fBF\fP').
That is to say, try to expand display on several screens. Screens to use are defined in config file.
.B \-g, \-\-hide\-gui
Hide all GUI windows (except the video window) on start. This is the same as
pressing `\fBG\fP' within xine.
.B \-H, \-\-hide\-video
Hide video output window.
.B \-L, \-\-no\-lirc
Turn off LIRC support. This option is \fIonly\~available\fP if xine has been compiled
with LIRC support.
.BI \-\-visual\ <visual\-class\-or\-id>
Try to use a specific X11 server visual for xine windows. The
\fI<visual\-class\-or\-id>\fP parameter is either the name of an X11 visual
class (\fBStaticGray\fP, \fBGrayScale\fP, \fBStaticColor\fP, \fBPseudoColor\fP, \fBTrueColor\fP or
\fBDirectColor\fP) or the \fBhexadecimal\fP value for a specific X11 visual.
When used with a visual class name, xine tries to find such a visual
with depth \fB15\fP or \fB16\fP, \fB24\fP, \fB32\fP or \fB8\fP (in that order).
The default visual class used by xine in absence of a \fI\-\-visual\fP option is \fBTrueColor\fP.
If no usable visual is found, xine falls back to the default visual used
on the X11 server's root window.
When using an X11 visual with changeable colors (colormaps), install a
private colormap for xine. With a private colormap, xine can allocate
more colors so that video output may look better.
.BI \-\-keymap\ [=option]
Display keymap. Option are:
`\fBdefault\fP' display default keymap table,
`\fBlirc\fP' display draft of a \fI~/.lircrc\fP config file,
`\fBremapped\fP' user remapped keymap table,
`\fBfile:<file>\fP' use \fBfile\fP as keymap table,
If no option is given, `\fBdefault\fP' is selected.
.B \-n, \-\-network
Enable network remote control server.
To use network remote control server, a password file is required.
If xine cannot find it, the server is stopped.
The syntax of the password file follows the (familliar) scheme
<\fIidentification\fP>:<\fIpassword\fP>. Since cryptography is subject to
legal issues in some countries, the password is not encrypted and also
transmitted unencrypted, so take care with remote connections.
Two (optional) generic rules are available as well (one at a time)
\fBALL:ALLOW\fP or \fBALL:DENY\fP
In the first case, all clients are allowed to execute all available commands,
without restriction. In the second case, no\-one is allowed to execute
any commands, except identified users (using 'identify' command).
If a password entry begins with an asterisk `\fB*\fP',
the user is blocked. If a password entry is empty,
the full entry is ignored. Here is an example
of a small \fI~/.xine/passwd\fP file:
This will allow only 'daniel' to execute commands,
after a successfully identifying stage.
The default port of the server is \fB6789\fP, this number is totally arbitrary. You can connect the server using a simple \fItelnet\fP command:
To change the default port, you can (as root) edit your \fI/etc/services\fP, and add an entry like this:
xinectl 7890/tcp # xine control
This will change the default port from 6789 to 7890, and create a "human" service
The server itself offers command help/syntax:
.BI help\ [command]
Without \fIcommand\fP specified, all available commands will be displayed.
If a command is specified, short text about the command functionnality will
.BI syntax\ <command>
Display the \fIcommand\fP syntax.
.B \-R, \-\-root
Use root window as video window.
.BI \-G,\ \-\-geometry\ <WxH[+X+Y]>
You can set video output size and position using the X like geometry (see \fBX\fR(7)).
\fBX\fP and \fBY\fP offset are optional.
.B \-B, \-\-borderless
Remove borders of video output window, in windowed mode.
.BI \-N,\ \-\-animation\ <mrl>
Specify one or more mrl to play with audio only streams.
.BI \-P,\ \-\-playlist\ <filename>
Use file as playlist. Known formats are: asx, toxine, m3u, pls, sfv and raw text file.
.BI \-l,\ \-\-loop\ [=mode]
Set playlist loop mode. If mode isn't specified, mode \fBloop\fP is used. Possible modes are:
\fBloop\fP: loop entire playlist.
\fBrepeat\fP: repeat current playlist entry.
\fBshuffle\fP: select randomly an entry in playlist from those not yet played.
\fBshuffle\+\fP: same as shuffle, but indefinetely replay the playlist.
.BI \-\-skin\-server\-url\ <url>
Define the skin server url.
.BI \-\-enqueue\ <mrl> ...
Enqueue one or more mrl in a running session (session 0).
If you want to specify another session, use \fB\-S session=\fP\fIx\fP option.
.BI \-S,\ \-\-session\ <option1,option2,...>
Session managements. All options can be used more than one time, except \fBsession\fP.
\fBsession=\fP\fIn\fP specify session \<\fIn\fP\> number,
\fBmrl=\fP\fIm\fP add mrl \<\fIm\fP\> to the playlist,
\fBaudio=\fP\fIc\fP select audio channel (\<\fIc\fP\>: \fBnext\fP or \fBprev\fP),
\fBspu=\fP\fIc\fP select spu channel (\<\fIc\fP\>: \fBnext\fP or \fBprev\fP),
\fBvolume=\fP\fIv\fP set audio volume (\<\fIv\fP\>: 0 to 100),
\fBamp=\fP\fIv\fP set audio amplification of instance (\<\fIv\fP\>: 0 to 200),
\fBloop=\fP\fIm\fP set loop mode (\<\fIm\fP\>: \fBnone\fP \fBloop\fP \fBrepeat\fP \fBshuffle\fP or \fBshuffle+\fP),
\fBget_speed\fP get current speed status. Return values are:
- 1: error
- 2: stop
- 3: play
- 4: pause
- 5: slow4
- 6: slow2
- 7: fast2
- 8: fast4
\<\fIp\fP\> can be:
\fBclear\fP: clear the playlist,
\fBfirst\fP: play first entry in the playlist,
\fBprev\fP: play previous playlist entry,
\fBnext\fP: play next playlist entry,
\fBlast\fP: play last entry in the playlist,
\fBload:\fP\fIs\fP: load playlist file <\fIs\fP>,
\fBstop\fP: stop playback at the end of the current playback,
\fBcont\fP: continue playback at the end of current playback.
There are also some self explanatory options.
\fBplay\fP, \fBslow2\fP, \fBslow4\fP, \fBpause\fP, \fBfast2\fP, \fBfast4\fP, \fBstop\fP, \fBquit\fP, \fBfullscreen\fP, \fBeject\fP.
Don't automatically start playback, affect only auto-start when smart mode is used.
.BI \-D,\ \-\-deinterlace\ [post[:..][;]]
Deinterlace video output. You can override configuration option of post(s) used to deinterlace the output picture. See \fI\-\-post\fP for syntax.
.BI \-r,\ \-\-aspect\-ratio\ <mode>
Set aspect ratio of video output. \<\fImode\fP\> can be:
\fBauto\fP, \fBsquare\fP, \fB4:3\fP, \fBanamorphic\fP, \fBdvb\fP.
.BI \-\-broadcast\-port\ <port>
Set port of xine broadcaster (master side), slave is started with 'xine slave://address:port'
Don't display the logo.
.BI \-E,\ \-\-no\-reload
Don't reload old playlist. Playlist is saved when you leave xine, then it is reloaded and played the next time you lanch xine. This feature can be disabled via setup window.
.BI \-\-post\ <plugin>[:parameter=value][,...][;...]
Load one or more post plugin(s). Parameters are comma separated. This option can be used more than one time to chain two or more video postprocess plugins. You can specify two or more plugin, which may be separated by a semi-colon ';'.
Don't enable post plugin(s). This way, you can specify one more plugin to use, using the --post command line option, but don't enable those effects.
Don't display the splash screen.
Turn on controlling xine over STDIN.
.BI \-T,\ \-\-tvout <backend>
Turn on TVout support. \<\fIbackend\fP\> can be: nvtv, ati.
.BI \-\-list\-plugins [=type]
Display the list of available plugins. Optional \<\fItype\fP\> can be:
audio_out, video_out, demux, input, sub, post, audio_decoder, video_decoder
.BI \-\-bug\-report [=mrl]
Enable bug report mode. It turn verbosity on, gather all output messages and write them to a file names BUG-REPORT.TXT. If \<\fImrl\fP\> is given, xine will play that mrl then quit (like -pq does).
If you don't specify any MRL, you'll have to select a file by drag'n\-drop.
Dragging files from the \fBGNOME\~Midnight\~Commander\fP (gmc), \fBNautilus\fP or \fBKonqueror\fP
is known to work.
.SH MRL (media resource locator)
MRLs are similar to URLs in your web browser. They describe the media
to read from. valid MRLs may be plain file names or one of the following:
.BI file: <path>
.BI fifo: <path>
Several MRLs may be specified in order to play a number of consecutive
streams. Additional input plugins will provide additional MRL types.
The ones listed above are available with stock libxine...
.SS VCD MRL Syntax
A simple \fBvcd:/\fP runs the default item (e.g. perhaps track 1 or entry
0) using the default VCD device (perhaps /dev/cdrom). Both the default
item and default device are user-configurable.
It is however also possible to specify both Video CD device/filename
and item explicitly in the MRL.
For example \fBvcd:/dev/dvd\fP specifies the default entry using device
/dev/dvd which might useful if this is your DVD which is different
than your CD-ROM device and your DVD drive can play CD's. And
\fBvcd://test_svcd_ntsc.cue\fP specifies the cue file for CD image on disk.
(test_svcd_ntsc.bin is the corresponding bin file, but using that
After the optional device name or file name, you can name the kind of
unit which preceded by a colon. An MRL which ends in a colon is like
not adding it at all: the default entry type and number is used. Items
come in 4 flavors: \fB"Track"\fP, \fB"Entry"\fP, \fB"Playback"\fP and
\fB"Segment"\fP. These units are indicated with the capital first letter of each
type: \fBT\fP, \fBE\fP, \fBP\fP, \fBS\fP, \fBs\fP. An uppercase \fBS\fP
in the MRL display indicates a NTS segment while a lowercase \fBS\fP
indicates a PAL segment. However when you
enter an MRL, the case of these letters is insignificant.
Depending on the Video CD, you might not have any playable segments
(\fBS\fP,\fBs\fP) or playback control (\fBP\fP). If you give a MRL that
refers to a playback control entry but there is no playback control, your
playback number will silently be converted into the corresponding entry number.
You can configure various things that affect MRLs are selected when
there is some ambiguity in the MRL name. media.vcd.autoplay sets what kind
of unit to to use in a MRL is none is given. Another configuration
setting, vcd.device, determines what device to use if that part is
not given. When you hit the VCD button, that is equivalent to
entering vcd:/ and thus these two configuration settings are used to
expand the MRL.
Some examples of MRLS are given below. In the examples, we assume the
following configuration settings:
Play (navigate) default item (in this case Entry ID 0) from the default device (in this case set to /dev/cdrom)
Same as above
same effect as above since the default device is set to /dev/cdrom.
Same as above. But note that this is because we have autoplay:entry which is no longer the default value
Play (navigate) the default item of /dev/cdrom2
should be same as above but is currently broken?
Play Track 1 from /dev/cdrom2
Play segment 1 from /dev/cdrom. This assumes there *is* a segment 1. Check the MRL list to see if that is the case.
Play Playlist item 1 from default device If there is no playback control, MRL will get converted into vcd:/:E0.
Again check the MRL list to see if there is a P1.
Probably same as above.
Play Entry id 1 from default device
Play segment 0 from default device
Play track 3 from default device
Play track 1 from /dev/cdrom2
Play default item (E0) of /tmp/ntsc.bin. Note trailing @
Play entry 0 of ntsc.bin
Play entry 0 of /tmp/ntsc.nrg (Nero file) Works for some simple Nero images.
.B external subtitle files (any mrl)
Text subtitle files may be appended to the MRL:
This is the xine-ui specific way to define the subtitle file to use. The filename will be
extracted by the frontend, that permit to change it, save it in a playlist, etc...
This is the xine-lib specific way to define the subtitle file to use. The frontend will
not take attention about the subtitle file.
.SH STREAM OPTIONS
After a delimiting \fB#\fP you can add several stream parameters:
video will be ignored
audio will be ignored
subpictures will be ignored
.BI demux: <demux\ name>
specify the demux plugin to use
.BI volume: <level>
set audio volume
.BI compression: <level>
set audio dynamic range compression
.BI <config\ entry> : <config\ value>
assign a new value to any config entry
.B change configuration option 'on the fly':
You can change a configuration option at anytime, using the special cfg:/ mrl style.
The syntax is:
cfg:/<config\ entry> : <config\ value>
Unlike stream config option, you can change anything \fIbefore\fP playing the stream.
.SH CONTROL KEYS
Many features can be controlled by pressing control keys. '\fBM\-\fP' is
the Meta key (`\fBAlt\fP' key on PC keyboard), '\fBC\-\fP' is the Control `\fBCTRL\fP'
key, other special key are delimited by '\fB<\fP' and '\fB>\fP' characters, eg: the `\fBHOME\fP' key is displayed \fB<home>\fP.
The default key bindings are:
Playback pause toggle
Take a snapshot
Eject the current medium
Select and play next MRL in the playlist
Select and play previous MRL in the playlist
Loop mode toggle
Scan playlist to grab stream infos
Add a mediamark from current playback
Edit selected mediamark
Set position to -60 seconds in current stream
Set position to +60 seconds in current stream
Set position to -30 seconds in current stream
Set position to +30 seconds in current stream
Set position to -15 seconds in current stream
Set position to +15 seconds in current stream
Set position to -7 seconds in current stream
Set position to +7 seconds in current stream
Set position to beginning of current stream
Set position to 10% of current stream
Set position to 20% of current stream
Set position to 30% of current stream
Set position to 40% of current stream
Set position to 50% of current stream
Set position to 60% of current stream
Set position to 70% of current stream
Set position to 80% of current stream
Set position to 90% of current stream
Increment playback speed
Decrement playback speed
Reset playback speed
Increment audio volume
Decrement audio volume
Increment amplification level
Decrement amplification level
Reset amplification to default value
Audio muting toggle
Select next audio channel
Select previous audio channel
Select next sub picture (subtitle) channel
Select previous sub picture (subtitle) channel
Interlaced mode toggle
Cycle aspect ratio values
Reduce the output window size by factor 1.2
Enlarge the output window size by factor 1.2
Set video output window to 50%
Set video output window to 100%
Set video output window to 200%
Zoom in horizontally
Zoom out horizontally
Zoom in vertically
Zoom out vertically
Resize output window to stream size
Xinerama fullscreen toggle
Jump to media Menu
Jump to Title Menu
Jump to Root Menu
Jump to Subpicture Menu
Jump to Audio Menu
Jump to Angle Menu
Jump to Part Menu
.IP "\fB\<Keypad Up\>\fP"
Menu navigate up
.IP "\fB\<Keypad Down\>\fP"
Menu navigate down
.IP "\fB\<Keypad Left\>\fP"
Menu navigate left
.IP "\fB\<Keypad Right\>\fP"
Menu navigate right
.IP "\fB\<Keypad Enter\>\fP"
.IP "\fB\<Keypad Next\>\fP"
Jump to next chapter
.IP "\fB\<Keypad Prior\>\fP"
Jump to previous chapter
.IP "\fB\<Keypad Home\>\fP"
Select next angle
.IP "\fB\<Keypad End\>\fP"
Select previous angle
Visibility toggle of help window
Visibility toggle of video post effect window
Toggle post effect usage
Visibility toggle of output window
Visibility toggle of UI windows
Visibility toggle of control window
Visibility toggle of mrl browser window
Visibility toggle of playlist editor window
Visibility toggle of the setup window
Visibility toggle of the event sender window
Visibility toggle of analog TV window
Visibility toggle of log viewer
Visibility toggle of stream info window
Display stream information using OSD
Enter key binding editor
Open file selector
Select a subtitle file
Download a skin from the skin server
Display MRL/Ident toggle
Grab pointer toggle
Enter the number 0
Enter the number 1
Enter the number 2
Enter the number 3
Enter the number 4
Enter the number 5
Enter the number 6
Enter the number 7
Enter the number 8
Enter the number 9
Add 10 to the next entered number
Set position in current stream to numeric percentage
See the section on "Numeric Input" below.
Set position forward by numeric argument in current stream
Set position back by numeric argument in current stream
Change audio video syncing (delay video)
Change audio video syncing (delay audio)
Reset audio video syncing offset
Change subtitle syncing (delay video)
Change subtitle syncing (delay subtitles)
Toggle TV modes (on the DXR3)
Switch Monitor to DPMS standby mode
Stop playback after played stream
Quit the program
.SS Third party plugins
Following shortcuts are used by third party plugins, generally for DVD navigation:
.IP "\fB<KeyPad\ Up>\fP"
.IP "\fB<KeyPad\ Down>\fP"
.IP "\fB<KeyPad\ Left>\fP"
.IP "\fB<KeyPad\ Right>\fP"
.IP "\fB<KeyPad\ Prior>\fP"
.IP "\fB<KeyPad\ Next>\fP"
.IP "\fB<KeyPad\ End>\fP"
Previous angle event.
.IP "\fB<KeyPad\ Home>\fP"
Next angle event.
.IP "\fB<KeyPad\ Enter>\fP"
.SS Synchronization fine tuning
Some streams have bad timestamps, so synchronization fails. This can be
tweaked using these keys:
press if video lags behind audio
press if video runs ahead of audio
press to reset audio/video offset to \fB0\fP, so stream timestamps are unchanged.
.SS Subtitle synchronization
You can adjust subtitle synchronization by using these keys:
.IP "M / N"
.SS Numeric Input
You can specify a numeric argument to be
applied to a command typing in a number and then entering a function
key. For example entering "99/", that is, the number-9 key twice and then
the slash key, you should seek 99% of the current stream.
The new VCD/SVCD plugin allows some numeric
input. Entering a number followed by the "Select event" (by default
the keypad enter), one can go to a specific "Chapter" (track or entry)
or selection number. As this is a relatively new feature, perhaps over
time more plugins will make use of numeric selection.
Other commands that can be numeric prefaced by a numeric argument are
next/previous MRL (\fBMRL_NEXT\fP, \fBMRL_PRIOR\fP), next/previous subtitle
(\fBSPU_NEXT\fP, \fBSPU_PRIOR\fP), and next/previous audio channel
(\fBAUDIOCHAN_NEXT\fP, \fBAUDIOCHAN_PRIOR\fP). With a numeric prefix, it is as
though one entered that command the number of times. Here, the
argument 0, since it would otherwise meaningless, is interpreted here
to be 1 instead.
Admittedly the use of numeric input here is of limited value. Over
time perhaps more useful commands like specifying a specific or
absolute MRL, subtitle or audio channel number will be implemented.
Main config file
Key bindings for xine-ui
Passwords file xine-ui
Additional command line arguments
Each line specifies an additional command line argument (one argument per line):
.SH "SEE ALSO"
The programs are documented fully on the xine home page:
This manual page was written by Siggi Langauf <firstname.lastname@example.org>,
for the xine project. Lots of additions by
Guenter Bartsch <email@example.com>,
Daniel Caujolle-Bert <firstname.lastname@example.org>,
Rocky Bernstein <email@example.com>, and
Philipp Hahn <firstname.lastname@example.org>.