xine
XINE(E)                                                 XINE(E)



NAME
       xine - a free video player

SYNOPSIS
       xine [options] [MRL] ...

DESCRIPTION
       This  manual  page  documents briefly the xine audio/video
       player.

       xine plays MPEG system (audio  and  video)  streams,  mpeg
       elementary  streams (e.g. .mp3 or .mpv files), mpeg trans-
       port streams, ogg files, avi files, asf  files,  quicktime
       files, (S)VCDs and DVDs.

OPTIONS
       The  programs  follow  the  usual GNU command line syntax,
       with long options starting with two dashes (`-').  A  sum-
       mary  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).

       -a, --audio-channel <num>
              Select the given audio channel. <num> is the  audio
              channel number, default is 0.
              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 sys-
              tem. This selection is stored automatically in your
              .xinerc  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 sys-
              tem. This selection is stored automatically in your
              .xinerc  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[f][h][w][q][d][v], --auto-play=[f][h][w][q][d][v]
              Start playing immediately after start. Can be  fol-
              lowed by:
              'f' in 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 <plugin>, --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 but-
              ton that the desired plugin adds to the xine panel!

       -f, --fullscreen
              Switch  xine to fullscreen mode on start (just like
              pressing 'F')

       -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  avail-
              able 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 spe-
              cific 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.

       --install
              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,
              If no option is given, 'default' is selected.

       -n, --network
              Enable  network remote control server.  To use net-
              work 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 <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  exe-
              cute  all  available commands, without restriction.
              In the second case, no-one is  allowed  to  execute
              any commands, except identified users (using 'iden-
              tify' 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:

              ALL:DENY
              daniel:mypasswd
              foo:*

              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:
              telnet localhost 6789
              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 called  xinectl.

              The server itself offers command help/syntax:
              help[command]
              Without  command  specified, all available commands
              will be displayed.   If  a  command  is  specified,
              short text about the command functionnality will be
              given.
              syntaxe<command>
              Display the command syntax.

       -R, --root
              Use root window as video window.

       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:
              file://<path>
              fifo://<path>
              stdin://mpeg1 or stdin://mpeg2
              dvd://VTS_xx_y.VOB
              vcd://<tracknumber>
              tcp://<host>:<port>
              rtp://<host>:<port>
              udp://<host>:<port>
              mms://<host>...
              http://<host>...

       Several MRLs may be specified in order to play a number of
       consecutive streams.

       If you don't specify any MRL, you'll have to select a file
       by  drag'n-drop.   Dragging  files  from  the  GNOME  Mid-
       night Commander (gmc), Nautilus or Konqueror is  known  to
       work.

       avi subtitle files
              Text  subtitle  files may be appended (seperated by
              `%') to a file MRL:
              file://<path>%<subtitlefile>

CONTROL KEYS
       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 key are delimited by
       '<'  and  '>'  characters, eg: the 'HOME' key is displayed
       <home>.  The default key bindings are:

       0..9: Jump to 0%..90% of current stream
       A: Toggle aspect ratio (AUTO/16:9/4:3/DVB)
       M-C|M-c: Show/hide the video settings window.
       E: Eject the current media.
       F: Toggle fullscreen mode.
       G: Hide/show the gui.
       H: Hide/show the video output window.
       i|I: Toggle deinterlace methods.
       M-l: Show/hide log window.
       M-m|M-M: Hide/show the MRL browser.
       C-m|C-M: Audio mute toggle.
       C-o: Toggle TV modes on the DXR3
       M-p|M-P: Show/hide the playlist window.
       Q: Exit.
       s: Zoom 1:1.
       S: Stop playback.
       M-s: Show/hide setup window.
       z|Z: Zoom in/out.
       M-C-z: Reset zoom.
       v: Decrease audio volume.
       V: Increase audio volume.
       t: Take a snapshot.
       <return>: Play
       <space>: Pause
       <up>/<down>: fast forward / slow motion
       c-<left>/C-<right>: seek -+ 15 sec.
       <left>/<right>: seek +- 60 sec.
       <page up>: Jump to previous stream in playlist
       <page down>: Jump to next stream in playlist
       <: Reduce the output window.
       >: Enlarge the ouput window.
       M-1: Set video output window to 50%
       M-2: Set video output window to 100%
       M-3: Set video output window to 200%
       .: Select next sub-title channel.
       ,: Select previous sub-title channel.
       +: Select next audio channel (may take up to a few seconds
       to take effect)
       -: Select prev audio channel
       Esc: Menu 1 (e.g. root menu)
       F1: Menu 2 (e.g. title menu)
       F2: Menu 3
       M-L: show log viewer window
       <Insert>: Grab pointer toggle.

       Following  shortcuts  are  used  by  third  party plugins,
       generally for DVD navigation:

       <KeyPad Up>: Up event.
       <KeyPad Down>: Down event.
       <KeyPad Left>: Left event.
       <KeyPad Right>: Right event.
       <KeyPad Prior>: Prior event.
       <KeyPad Next>: Next event.
       <KeyPad End>: Previous angle event.
       <KeyPad Home>: Next angle event.
       <KeyPad Enter>: Select event

Synchronization fine tuning
       Some  streams  have  bad  timestamps,  so  synchronization
       fails. This can be tweaked using these keys:
       n|N: press if video runs ahead of audio
       m|M: press if video lags behind audio
       <home>:  press to reset audio/video offset to 0, so stream
       timestamps are unchanged.

FILES
       All config files are now to be found in ~/.xine:
       ~/.xine/config: main config file
       ~/.xine/keymap: key bindings for xine-ui
       ~/.xine/passwd: passwords file xine-ui

SEE ALSO
       xine-remote(e).
       The programs are documented fully on the xine  home  page:
       http://xine.sourceforge.net/

AUTHOR
       This   manual   page   was   written   by   Siggi  Langauf
       <siggi@debian.org>, for the xine project.  Lots  of  addi-
       tions  by  Guenter Bartsch <guenter@users.sourceforge.net>
       and Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>



The xine project            2002-04-16                   XINE(E)