Section: User Commands (1)
Return to Main Contents
xine - a free video player
[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 README and FAQ in /usr/share/doc/xine-ui
or on the xine home page.
- -h, --help
Show summary of options and available output drivers (plugins).
Set verbose level.
Use config file instead of default one.
- -a, --audio-channel <num>
Select the given audio channel. <num> 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 0.
- -V, --video-driver <drv>
Select video driver. Check out xine --help for a list of available
video output plugins on your system. This selection is stored automatically
in your ~/.xine/config so you'll have to specify the video driver only once.
- -A, --audio-driver <drv>
Select audio driver. Check out xine --help for a list of available
audio output plugins on your system. This selection is stored automatically
in your ~/.xine/config so you'll have to specify the audio driver only once.
- -u, --spu-channel <num>
Select subpicture (subtitle) channel. <num> is the subpicture channel
id, default is no subtitle (-1).
- -p, --auto-play=[f][F][h][w][q][d][v]
Start playing immediately after start. Can be followed by:
`f' in fullscreen mode,
`F' in xinerama fullscreen mode,
`h' hide GUI (main panel, etc...),
`w' hide video output window,
`q' for quitting after playback,
It is also possible to request the playlist from DVD `d', or VCD `v'.
There is now a more generic option, --auto-scan, for that (see below).
- -s, --auto-scan <plugin>
Auto-scan playlist from named input plugin. Many plugins allow to read a
default playlist, in order to play everything. 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 xine~--auto-play~--auto-scan~dvd 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!
- -f, --fullscreen
Switch xine to fullscreen mode on start (just like pressing `f')
- -F, --xineramafull
Switch xine to xinerama fullscreen mode on start (just like pressing `F').
That is to say, try to expand display on several screens. Screens to use are defined in config file.
- -g, --hide-gui
Hide all GUI windows (except the video window) on start. This is the same as
pressing `G' within xine.
- -H, --hide-video
Hide video output window.
- -L, --no-lirc
Turn off LIRC support. This option is only~available if xine has been compiled
with LIRC support.
- --visual <visual-class-or-id>
Try to use a specific X11 server visual for xine windows. The
<visual-class-or-id> parameter is either the name of an X11 visual
class (StaticGray, GrayScale, StaticColor, PseudoColor, TrueColor or
DirectColor) or the hexadecimal value for a specific X11 visual.
When used with a visual class name, xine tries to find such a visual
with depth 15 or 16, 24, 32 or 8 (in that order).
The default visual class used by xine in absence of a --visual option is TrueColor.
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.
- --keymap [=option]
Display keymap. Option are:
`default' display default keymap table,
`lirc' display draft of a ~/.lircrc config file,
`remapped' user remapped keymap table,
`file:<file>' use file as keymap table,
If no option is given, `default' is selected.
- -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 (familiar) scheme
<identification>:<password>. 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)
ALL:ALLOW or ALL:DENY
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 `*',
the user is blocked. If a password entry is empty,
the full entry is ignored. Here is an example
of a small ~/.xine/passwd file:
This will allow only 'daniel' to execute commands,
after a successfully identifying stage.
The default port of the server is 6789, this number is totally arbitrary. You can connect the server using a simple telnet command:
To change the default port, you can (as root) edit your /etc/services, 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:
Without command specified, all available commands will be displayed.
If a command is specified, short text about the command functionality will
Display the command syntax.
- -R, --root
Use root window as video window.
- -G, --geometry <WxH[+X+Y]>
You can set video output size and position using the X like geometry (see X(7)).
X and Y offset are optional.
- -B, --borderless
Remove borders of video output window, in windowed mode.
- -N, --animation <mrl>
Specify one or more mrl to play with audio only streams.
- -P, --playlist <filename>
Use file as playlist. Known formats are: asx, toxine, m3u, pls, sfv and raw text file.
- -l, --loop [=mode]
Set playlist loop mode. If mode isn't specified, mode loop is used. Possible modes are:
loop: loop entire playlist.
repeat: repeat current playlist entry.
shuffle: select randomly an entry in playlist from those not yet played.
shuffle+: same as shuffle, but indefinitely replay the playlist.
- --skin-server-url <url>
Define the skin server url.
- --enqueue <mrl>...
Enqueue one or more mrl in a running session (session 0).
If you want to specify another session, use -S session=x option.
- -S, --session <option1,option2,...>
Session managements. All options can be used more than one time, except session.
session=n specify session <n> number,
mrl=m add mrl <m> to the playlist,
audio=c select audio channel (<c>: next or prev),
spu=c select spu channel (<c>: next or prev),
volume=v set audio volume (<v>: 0 to 100),
amp=v set audio amplification of instance (<v>: 0 to 200),
loop=m set loop mode (<m>: none loop repeat shuffle or shuffle+),
get_speed get current speed status. Return values are:
- 1: error
- 2: stop
- 3: play
- 4: pause
- 5: slow4
- 6: slow2
- 7: fast2
- 8: fast4
get_time[=p|pos] get current position status in seconds, or in position in stream (0..65535).
<p> can be:
clear: clear the playlist,
first: play first entry in the playlist,
prev: play previous playlist entry,
next: play next playlist entry,
last: play last entry in the playlist,
load:s: load playlist file <s>,
stop: stop playback at the end of the current playback,
cont: continue playback at the end of current playback.
There are also some self explanatory options.
play, slow2, slow4, pause, fast2, fast4, stop, quit, fullscreen, eject.
Don't automatically start playback, affect only auto-start when smart mode is used.
- -D, --deinterlace [post[:..][;]]
Deinterlace video output. You can override configuration option of post(s) used to deinterlace the output picture. See --post for syntax.
- -r, --aspect-ratio <mode>
Set aspect ratio of video output. <mode> can be:
auto, square, 4:3, anamorphic, dvb.
- --broadcast-port <port>
Set port of xine broadcaster (master side), slave is started with 'xine slave://address:port'
Don't display the logo.
- -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.
- --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.
- -T, --tvout<backend>
Turn on TVout support. <backend> can be: nvtv, ati.
Display the list of available plugins. Optional <type> can be:
audio_out, video_out, demux, input, sub, post, audio_decoder, video_decoder
Enable bug report mode. It turn verbosity on, gather all output messages and write them to a file names BUG-REPORT.TXT. If <mrl> 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 GNOME~Midnight~Commander (gmc), Nautilus or Konqueror
is known to work.
MRL (media resource locator)
MRLs are similar to URLs in your web browser. They describe the media
to read from. xine(5) describes them in some detail. xine extends
the syntax as follows:
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...
After a delimiting # you can add several stream parameters:
video will be ignored
audio will be ignored
subpictures will be ignored
- demux:<demux name>
specify the demux plugin to use
set audio volume
set audio dynamic range compression
- <config entry>:<config value>
assign a new value to any config entry
- 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 before playing the stream.
Many features can be controlled by pressing control keys. `M-' is
the Meta key (`Alt' key on PC keyboard), `C-' is the Control `CTRL'
key, other special keys are delimited by `<' and `>' characters, e.g. the `HOME' key is displayed as <home>.
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
Video window borders appearance 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
- <Keypad Up>
Menu navigate up
- <Keypad Down>
Menu navigate down
- <Keypad Left>
Menu navigate left
- <Keypad Right>
Menu navigate right
- <Keypad Enter>
- <Keypad Next>
Jump to next chapter
- <Keypad Prior>
Jump to previous chapter
- <Keypad Home>
Select next angle
- <Keypad End>
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
Third party plugins
Following shortcuts are used by third party plugins, generally for DVD navigation:
- <KeyPad Up>
- <KeyPad Down>
- <KeyPad Left>
- <KeyPad Right>
- <KeyPad Prior>
- <KeyPad Next>
- <KeyPad End>
Previous angle event.
- <KeyPad Home>
Next angle event.
- <KeyPad Enter>
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 0, so stream timestamps are unchanged.
You can adjust subtitle synchronization by using these keys:
- M / N
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 (MRL_NEXT, MRL_PRIOR), next/previous subtitle
(SPU_NEXT, SPU_PRIOR), and next/previous audio channel
(AUDIOCHAN_NEXT, AUDIOCHAN_PRIOR). 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):
xine(5) for details of the MRL syntax
The programs are documented fully on the xine home page:
This manual page was written by Siggi Langauf <email@example.com>,
for the xine project. Lots of additions by
Guenter Bartsch <firstname.lastname@example.org>,
Daniel Caujolle-Bert <email@example.com>,
Rocky Bernstein <firstname.lastname@example.org>, and
Philipp Hahn <email@example.com>.
- MRL (media resource locator)
- STREAM OPTIONS
- CONTROL KEYS
- Third party plugins
- Synchronization fine tuning
- Subtitle synchronization
- Numeric Input
- SEE ALSO
linux.jgfs.net manual pages