1XINE(1) General Commands Manual XINE(1)
2
3
4
6 xine - a free video player
7
9 xine [options] [MRL] ...
10
12 This manual page documents briefly the xine audio/video player.
13
14 xine plays MPEG system (audio and video) streams, mpeg elementary
15 streams (e.g. .mp3 or .mpv files), mpeg transport streams, ogg files,
16 avi files, asf files, quicktime files, (S)VCDs and DVDs and many more.
17
19 The programs follow the usual GNU command line syntax, with long
20 options starting with two dashes (`--'). A summary of options are
21 included below. For a complete description, see README and FAQ in
22 /usr/share/doc/xine-ui-0.99.6 or on the xine home page.
23
24 -h, --help
25 Show summary of options and available output drivers (plugins).
26
27 --verbose[=level]
28 Set verbose level.
29
30 --config<file>
31 Use config file instead of default one.
32
33 -a, --audio-channel <num>
34 Select the given audio channel. <num> is the audio channel num‐
35 ber, default is 0.
36 xine 0.5 and newer tries its best to collect all valid audio
37 channels (ac3, mpeg audio, avi audio, ...) from the stream and
38 maps them to "virtual channels" with channel numbers starting at
39 0.
40
41 -V, --video-driver <drv>
42 Select video driver. Check out xine --help for a list of avail‐
43 able video output plugins on your system. This selection is
44 stored automatically in your ~/.xine/config so you'll have to
45 specify the video driver only once.
46
47 -A, --audio-driver <drv>
48 Select audio driver. Check out xine --help for a list of avail‐
49 able audio output plugins on your system. This selection is
50 stored automatically in your ~/.xine/config so you'll have to
51 specify the audio driver only once.
52
53 -u, --spu-channel <num>
54 Select subpicture (subtitle) channel. <num> is the subpicture
55 channel id, default is no subtitle (-1).
56
57 -p, --auto-play=[f][F][h][w][q][d][v]
58 Start playing immediately after start. Can be followed by:
59 `f' in fullscreen mode,
60 `F' in xinerama fullscreen mode,
61 `h' hide GUI (main panel, etc...),
62 `w' hide video output window,
63 `q' for quitting after playback,
64 It is also possible to request the playlist from DVD `d', or VCD
65 `v'. There is now a more generic option, --auto-scan, for that
66 (see below).
67
68 -s, --auto-scan <plugin>
69 Auto-scan playlist from named input plugin. Many plugins allow
70 to read a default playlist, in order to play everything. This
71 works fine for DVDs or VCDs, for example. Giving this option has
72 the same effect as pressing the according button on xine's main
73 panel.
74
75 This option is especially useful in combination with auto-play.
76 You could start xine --auto-play --auto-scan dvd in order to
77 play a whole DVD without having to press any additional buttons.
78 This also works for plugins that are not supplied with xine,
79 just give the name of the button that the desired plugin adds to
80 the xine panel!
81
82 -f, --fullscreen
83 Switch xine to fullscreen mode on start (just like pressing `f')
84
85 -F, --xineramafull
86 Switch xine to xinerama fullscreen mode on start (just like
87 pressing `F'). That is to say, try to expand display on several
88 screens. Screens to use are defined in config file.
89
90 -g, --hide-gui
91 Hide all GUI windows (except the video window) on start. This is
92 the same as pressing `G' within xine.
93
94 -H, --hide-video
95 Hide video output window.
96
97 -L, --no-lirc
98 Turn off LIRC support. This option is only available if xine has
99 been compiled with LIRC support.
100
101 --visual <visual-class-or-id>
102 Try to use a specific X11 server visual for xine windows. The
103 <visual-class-or-id> parameter is either the name of an X11 vis‐
104 ual class (StaticGray, GrayScale, StaticColor, PseudoColor,
105 TrueColor or DirectColor) or the hexadecimal value for a spe‐
106 cific X11 visual.
107
108 When used with a visual class name, xine tries to find such a
109 visual with depth 15 or 16, 24, 32 or 8 (in that order). The
110 default visual class used by xine in absence of a --visual
111 option is TrueColor.
112
113 If no usable visual is found, xine falls back to the default
114 visual used on the X11 server's root window.
115
116 --install
117 When using an X11 visual with changeable colors (colormaps),
118 install a private colormap for xine. With a private colormap,
119 xine can allocate more colors so that video output may look bet‐
120 ter.
121
122 --keymap [=option]
123 Display keymap. Option are:
124 `default' display default keymap table,
125 `lirc' display draft of a ~/.lircrc config file,
126 `remapped' user remapped keymap table,
127 `file:<file>' use file as keymap table,
128 If no option is given, `default' is selected.
129
130 -n, --network
131 Enable network remote control server. To use network remote
132 control server, a password file is required. If xine cannot
133 find it, the server is stopped. The syntax of the password file
134 follows the (familiar) scheme <identification>:<password>. Since
135 cryptography is subject to legal issues in some countries, the
136 password is not encrypted and also transmitted unencrypted, so
137 take care with remote connections. Two (optional) generic rules
138 are available as well (one at a time)
139 ALL:ALLOW or ALL:DENY
140 In the first case, all clients are allowed to execute all avail‐
141 able commands, without restriction. In the second case, no-one
142 is allowed to execute any commands, except identified users
143 (using 'identify' command).
144
145 If a password entry begins with an asterisk `*', the user is
146 blocked. If a password entry is empty, the full entry is
147 ignored. Here is an example of a small ~/.xine/passwd file:
148
149 ALL:DENY
150 daniel:mypasswd
151 foo:*
152
153 This will allow only 'daniel' to execute commands, after a suc‐
154 cessfully identifying stage.
155
156 The default port of the server is 6789, this number is totally
157 arbitrary. You can connect the server using a simple telnet com‐
158 mand:
159 telnet localhost 6789
160 To change the default port, you can (as root) edit your
161 /etc/services, and add an entry like this:
162
163 xinectl 7890/tcp # xine control
164
165 This will change the default port from 6789 to 7890, and create
166 a "human" service called xinectl.
167
168 The server itself offers command help/syntax:
169 help [command]
170 Without command specified, all available commands will be dis‐
171 played. If a command is specified, short text about the command
172 functionality will be given.
173 syntax <command>
174 Display the command syntax.
175
176 -R, --root
177 Use root window as video window.
178
179 -G, --geometry <WxH[+X+Y]>
180 You can set video output size and position using the X like
181 geometry (see X(7)). X and Y offset are optional.
182
183 -B, --borderless
184 Remove borders of video output window, in windowed mode.
185
186 -N, --animation <mrl>
187 Specify one or more mrl to play with audio only streams.
188
189 -P, --playlist <filename>
190 Use file as playlist. Known formats are: asx, toxine, m3u, pls,
191 sfv and raw text file.
192
193 -l, --loop [=mode]
194 Set playlist loop mode. If mode isn't specified, mode loop is
195 used. Possible modes are:
196 loop: loop entire playlist.
197 repeat: repeat current playlist entry.
198 shuffle: select randomly an entry in playlist from those not yet
199 played.
200 shuffle+: same as shuffle, but indefinitely replay the playlist.
201
202 --skin-server-url <url>
203 Define the skin server url.
204
205 --enqueue <mrl>...
206 Enqueue one or more mrl in a running session (session 0).
207 If you want to specify another session, use -S session=x option.
208
209 -S, --session <option1,option2,...>
210 Session managements. All options can be used more than one time,
211 except session.
212 Options are:
213 session=n specify session <n> number,
214 mrl=m add mrl <m> to the playlist,
215 audio=c select audio channel (<c>: next or prev),
216 spu=c select spu channel (<c>: next or prev),
217 volume=v set audio volume (<v>: 0 to 100),
218 amp=v set audio amplification of instance (<v>: 0 to 200),
219 loop=m set loop mode (<m>: none loop repeat shuffle or shuf‐
220 fle+),
221 get_speed get current speed status. Return values are:
222 - 1: error
223 - 2: stop
224 - 3: play
225 - 4: pause
226 - 5: slow4
227 - 6: slow2
228 - 7: fast2
229 - 8: fast4
230 get_time[=p|pos] get current position status in seconds, or in
231 position in stream (0..65535).
232 (playlist|pl)=p
233 <p> can be:
234 clear: clear the playlist,
235 first: play first entry in the playlist,
236 prev: play previous playlist entry,
237 next: play next playlist entry,
238 last: play last entry in the playlist,
239 load:s: load playlist file <s>,
240 stop: stop playback at the end of the current playback,
241 cont: continue playback at the end of current playback.
242 There are also some self explanatory options.
243 play, slow2, slow4, pause, fast2, fast4, stop, quit,
244 fullscreen, eject.
245
246 -Z Don't automatically start playback, affect only auto-start when
247 smart mode is used.
248
249 -D, --deinterlace [post[:..][;]]
250 Deinterlace video output. You can override configuration option
251 of post(s) used to deinterlace the output picture. See --post
252 for syntax.
253
254 -r, --aspect-ratio <mode>
255 Set aspect ratio of video output. <mode> can be: auto, square,
256 4:3, anamorphic, dvb.
257
258 --broadcast-port <port>
259 Set port of xine broadcaster (master side), slave is started
260 with 'xine slave://address:port'
261
262 --no-logo
263 Don't display the logo.
264
265 -E, --no-reload
266 Don't reload old playlist. Playlist is saved when you leave
267 xine, then it is reloaded and played the next time you lanch
268 xine. This feature can be disabled via setup window.
269
270 --post <plugin>[:parameter=value][,...][;...]
271 Load one or more post plugin(s). Parameters are comma separated.
272 This option can be used more than one time to chain two or more
273 video postprocess plugins. You can specify two or more plugin,
274 which may be separated by a semi-colon ';'.
275
276 --disable-post
277 Don't enable post plugin(s). This way, you can specify one more
278 plugin to use, using the --post command line option, but don't
279 enable those effects.
280
281 --no-splash
282 Don't display the splash screen.
283
284 --stdctl
285 Turn on controlling xine over STDIN.
286
287 -T, --tvout<backend>
288 Turn on TVout support. <backend> can be: nvtv, ati.
289
290 --list-plugins[=type]
291 Display the list of available plugins. Optional <type> can be:
292 audio_out, video_out, demux, input, sub, post, audio_decoder,
293 video_decoder
294
295 --bug-report[=mrl]
296 Enable bug report mode. It turn verbosity on, gather all output
297 messages and write them to a file names BUG-REPORT.TXT. If <mrl>
298 is given, xine will play that mrl then quit (like -pq does).
299
300 If you don't specify any MRL, you'll have to select a file by
301 drag'n-drop. Dragging files from the GNOME Midnight Commander (gmc),
302 Nautilus or Konqueror is known to work.
303
305 MRLs are similar to URLs in your web browser. They describe the media
306 to read from. xine(5) describes them in some detail. xine extends the
307 syntax as follows:
308
309 <mrl>::<subtitlefile>
310 This is the xine-ui specific way to define the subtitle file to
311 use. The filename will be extracted by the frontend, that permit
312 to change it, save it in a playlist, etc...
313
315 After a delimiting # you can add several stream parameters:
316
317 novideo
318 video will be ignored
319
320 noaudio
321 audio will be ignored
322
323 nospu subpictures will be ignored
324
325 demux:<demux name>
326 specify the demux plugin to use
327
328 volume:<level>
329 set audio volume
330
331 compression:<level>
332 set audio dynamic range compression
333
334 <config entry>:<config value>
335 assign a new value to any config entry
336
337 change configuration option 'on the fly':
338 You can change a configuration option at anytime, using the spe‐
339 cial cfg:/ mrl style. The syntax is:
340 cfg:/<config entry> : <config value>
341 Unlike stream config option, you can change anything before
342 playing the stream.
343
345 Many features can be controlled by pressing control keys. `M-' is the
346 Meta key (`Alt' key on PC keyboard), `C-' is the Control `CTRL' key,
347 other special keys are delimited by `<' and `>' characters, e.g. the
348 `HOME' key is displayed as <home>. The default key bindings are:
349
350 <Return>
351 Start playback
352
353 <space>
354 Playback pause toggle
355
356 S Stop playback
357
358 t Take a snapshot
359
360 e Eject the current medium
361
362 <Next> Select and play next MRL in the playlist
363
364 <Prior>
365 Select and play previous MRL in the playlist
366
367 l Loop mode toggle
368
369 C-s Scan playlist to grab stream infos
370
371 C-a Add a mediamark from current playback
372
373 C-e Edit selected mediamark
374
375 <Left> Set position to -60 seconds in current stream
376
377 <Right>
378 Set position to +60 seconds in current stream
379
380 M-<Left>
381 Set position to -30 seconds in current stream
382
383 M-<Right>
384 Set position to +30 seconds in current stream
385
386 C-<Left>
387 Set position to -15 seconds in current stream
388
389 C-<Right>
390 Set position to +15 seconds in current stream
391
392 M3-<Left>
393 Set position to -7 seconds in current stream
394
395 M3-<Right>
396 Set position to +7 seconds in current stream
397
398 C-0 Set position to beginning of current stream
399
400 C-1 Set position to 10% of current stream
401
402 C-2 Set position to 20% of current stream
403
404 C-3 Set position to 30% of current stream
405
406 C-4 Set position to 40% of current stream
407
408 C-5 Set position to 50% of current stream
409
410 C-6 Set position to 60% of current stream
411
412 C-7 Set position to 70% of current stream
413
414 C-8 Set position to 80% of current stream
415
416 C-9 Set position to 90% of current stream
417
418 <Up> Increment playback speed
419
420 <Down> Decrement playback speed
421
422 M-<Down>
423 Reset playback speed
424
425 V Increment audio volume
426
427 v Decrement audio volume
428
429 C-V Increment amplification level
430
431 C-v Decrement amplification level
432
433 C-A Reset amplification to default value
434
435 C-m Audio muting toggle
436
437 <plus> Select next audio channel
438
439 <minus>
440 Select previous audio channel
441
442 <period>
443 Select next sub picture (subtitle) channel
444
445 <comma>
446 Select previous sub picture (subtitle) channel
447
448 i Interlaced mode toggle
449
450 a Cycle aspect ratio values
451
452 <less> Reduce the output window size by factor 1.2
453
454 <greater>
455 Enlarge the output window size by factor 1.2
456
457 M-1 Set video output window to 50%
458
459 M-2 Set video output window to 100%
460
461 M-3 Set video output window to 200%
462
463 z Zoom in
464
465 Z Zoom out
466
467 C-z Zoom in horizontally
468
469 C-Z Zoom out horizontally
470
471 M-z Zoom in vertically
472
473 M-Z Zoom out vertically
474
475 C-M-z Reset zooming
476
477 s Resize output window to stream size
478
479 f Fullscreen toggle
480
481 F Xinerama fullscreen toggle
482
483 b Video window borders appearance toggle
484
485 <Escape>
486 Jump to media Menu
487
488 <F1> Jump to Title Menu
489
490 <F2> Jump to Root Menu
491
492 <F3> Jump to Subpicture Menu
493
494 <F4> Jump to Audio Menu
495
496 <F5> Jump to Angle Menu
497
498 <F6> Jump to Part Menu
499
500 <Keypad Up>
501 Menu navigate up
502
503 <Keypad Down>
504 Menu navigate down
505
506 <Keypad Left>
507 Menu navigate left
508
509 <Keypad Right>
510 Menu navigate right
511
512 <Keypad Enter>
513 Menu select
514
515 <Keypad Next>
516 Jump to next chapter
517
518 <Keypad Prior>
519 Jump to previous chapter
520
521 <Keypad Home>
522 Select next angle
523
524 <Keypad End>
525 Select previous angle
526
527 M-h Visibility toggle of help window
528
529 M-P Visibility toggle of video post effect window
530
531 C-M-P Toggle post effect usage
532
533 h Visibility toggle of output window
534
535 g Visibility toggle of UI windows
536
537 M-c Visibility toggle of control window
538
539 M-m Visibility toggle of mrl browser window
540
541 M-p Visibility toggle of playlist editor window
542
543 M-s Visibility toggle of the setup window
544
545 M-e Visibility toggle of the event sender window
546
547 M-t Visibility toggle of analog TV window
548
549 M-l Visibility toggle of log viewer
550
551 M-i Visibility toggle of stream info window
552
553 C-i Display stream information using OSD
554
555 M-k Enter key binding editor
556
557 C-o Open file selector
558
559 C-S Select a subtitle file
560
561 C-d Download a skin from the skin server
562
563 C-t Display MRL/Ident toggle
564
565 <Insert>
566 Grab pointer toggle
567
568 0 Enter the number 0
569
570 1 Enter the number 1
571
572 2 Enter the number 2
573
574 3 Enter the number 3
575
576 4 Enter the number 4
577
578 5 Enter the number 5
579
580 6 Enter the number 6
581
582 7 Enter the number 7
583
584 8 Enter the number 8
585
586 9 Enter the number 9
587
588 M3-<plus>
589 Add 10 to the next entered number
590
591 <slash>
592 Set position in current stream to numeric percentage See the
593 section on "Numeric Input" below.
594
595 M-<Up> Set position forward by numeric argument in current stream
596
597 M3-<Up>
598 Set position back by numeric argument in current stream
599
600 m Change audio video syncing (delay video)
601
602 n Change audio video syncing (delay audio)
603
604 <Home> Reset audio video syncing offset
605
606 M Change subtitle syncing (delay video)
607
608 N Change subtitle syncing (delay subtitles)
609
610 C-M-o Toggle TV modes (on the DXR3)
611
612 d Switch Monitor to DPMS standby mode
613
614 C-l Stop playback after played stream
615
616 q Quit the program
617
618 Third party plugins
619 Following shortcuts are used by third party plugins, generally for DVD
620 navigation:
621
622 <KeyPad Up>
623 Up event.
624
625 <KeyPad Down>
626 Down event.
627
628 <KeyPad Left>
629 Left event.
630
631 <KeyPad Right>
632 Right event.
633
634 <KeyPad Prior>
635 Prior event.
636
637 <KeyPad Next>
638 Next event.
639
640 <KeyPad End>
641 Previous angle event.
642
643 <KeyPad Home>
644 Next angle event.
645
646 <KeyPad Enter>
647 Select event
648
649
650 Synchronization fine tuning
651 Some streams have bad timestamps, so synchronization fails. This can be
652 tweaked using these keys:
653
654 n press if video lags behind audio
655
656 m press if video runs ahead of audio
657
658 <home> press to reset audio/video offset to 0, so stream timestamps are
659 unchanged.
660
661
662 Subtitle synchronization
663 You can adjust subtitle synchronization by using these keys:
664
665 M / N
666
667
668 Numeric Input
669 You can specify a numeric argument to be applied to a command typing in
670 a number and then entering a function key. For example entering "99/",
671 that is, the number-9 key twice and then the slash key, you should seek
672 99% of the current stream.
673
674 The new VCD/SVCD plugin allows some numeric input. Entering a number
675 followed by the "Select event" (by default the keypad enter), one can
676 go to a specific "Chapter" (track or entry) or selection number. As
677 this is a relatively new feature, perhaps over time more plugins will
678 make use of numeric selection.
679
680 Other commands that can be numeric prefaced by a numeric argument are
681 next/previous MRL (MRL_NEXT, MRL_PRIOR), next/previous subtitle
682 (SPU_NEXT, SPU_PRIOR), and next/previous audio channel (AUDIOCHAN_NEXT,
683 AUDIOCHAN_PRIOR). With a numeric prefix, it is as though one entered
684 that command the number of times. Here, the argument 0, since it would
685 otherwise meaningless, is interpreted here to be 1 instead.
686
687 Admittedly the use of numeric input here is of limited value. Over time
688 perhaps more useful commands like specifying a specific or absolute
689 MRL, subtitle or audio channel number will be implemented.
690
691
693 ~/.xine/config Main config file
694
695 ~/.xine/keymap Key bindings for xine-ui
696
697 ~/.xine/passwd Passwords file xine-ui
698
699 ~/.xine/xinerc Additional command line arguments
700 Each line specifies an additional command line argument
701 (one argument per line):
702 --geometry 720x576+0+0
703 --network
704 -s DVD
705 -p
706
708 xine-remote(1)
709 xine(5) for details of the MRL syntax
710
711 The programs are documented fully on the xine home page:
712 http://www.xine-project.org/ ⟨http://www.xine-project.org/⟩
713
715 This manual page was written by Siggi Langauf <siggi@debian.org>, for
716 the xine project. Lots of additions by Guenter Bartsch
717 <guenter@users.sourceforge.net>, Daniel Caujolle-Bert
718 <f1rmb@users.sourceforge.net>, Rocky Bernstein <rocky@panix.com>, and
719 Philipp Hahn <pmhahn@users.sourceforge.net>.
720
721
722
723The xine project 2002-04-16 XINE(1)