doc/vlc.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH VLC 1 "Feb 14, 2005"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 vlc, qvlc, svlc, nvlc, rvlc, cvlc \- the VLC media player
  20 .SH SYNOPSIS
  21 .B vlc
  22 .RI [ OPTIONS ]
  23 .RI [ ITEMS ]...
  24 .SH DESCRIPTION
  25 This manual page documents briefly the
  26 .B VLC
  27 multimedia player and server.
  28
  29 .SH OPTIONS
  30 .B VLC
  31 follows the usual GNU command line syntax, with long
  32 options starting with two dashes (`-').
  33 For a precise description of options, please use "vlc \-\-help".
  34
  35 The complete list of
  36 .B VLC
  37 options depends on what plugins are installed because they automatically
  38 add their own options. Please use "vlc \-\-longhelp \-\-advanced" for a
  39 complete list of available options.
  40
  41 .SH ITEMS
  42 .B VLC
  43 recognizes several URL-style items:
  44 .TP
  45 .B *.mpg, *.vob, *.avi, *.mp3, *.ogg, *.opus
  46 Various multimedia file formats
  47 .TP
  48 .B dvd://[<device>][@<raw device>][#[<title>][:[<chapter>][:<angle>]]]
  49 DVD device (for instance dvd:///dev/dvd). The raw device is optional and
  50 must have been prepared beforehand.
  51 .TP
  52 .B vcd://[<device>][@{E|P|E|T|S}[<number>]]
  53 VCD device (for instance vcd:///dev/cdrom).
  54 .TP
  55 .B udp://[@[<multicast address>][:<local port>]]
  56 UDP stream, such as one sent by VLS or another VLC.
  57 Usually "udp://" is enough.
  58 .TP
  59 .B http://<server address>[:<server port>]/[<file>]
  60 HTTP stream
  61 .TP
  62 .B rtsp://<server address>[:<server port>]/<stream name>
  63 RTSP Video On Demand stream
  64 .TP
  65 .B vlc://<command>
  66 Execute a playlist command. Commands are:
  67 .B pause
  68 (pause execution of other items), and
  69 .B quit
  70 (close VLC).
  71
  72 .SH ENVIRONMENT VARIABLES
  73 The following environment variables may affect VLC:
  74
  75 .TP
  76 .B DISPLAY
  77 The X11 display server address.
  78
  79 .TP
  80 .B http_proxy
  81 The HTTP proxy server URL.
  82
  83 .TP
  84 .B OSSAUDIO_DEV
  85 The default audio output device,
  86 used by the OSSv4 output plugin.
  87
  88 .TP
  89 .B VLC_DATA_PATH
  90 The directory containing VLC run-time data files (e.g. /usr/share/vlc).
  91
  92 .TP
  93 .B VLC_PLUGIN_PATH
  94 An extra directory to load VLC plugins from.
  95
  96 .TP
  97 .B VLC_VERBOSE
  98 The level of verbosity for log messages
  99 (0: silent, 1: error/info, 2: warning, 3: debug).
 100
 101 .TP
 102 .B XDG_CACHE_DIR XDG_CONFIG_DIR XDG_DATA_DIR
 103 The directories to store user cached data, user configuration files and
 104 user data files respectively.
 105
 106 .TP
 107 .B XDG_DOCUMENTS_DIR XDG_DOWNLOAD_DIR XDG_MUSIC_DIR XDG_PICTURES_DIR XDG_VIDEO_DIR
 108 The directories to fetch or store user text files,
 109 downloads, music, pictures (i.e. snapshots), and video respectively.
 110
 111 .TP
 112 .B XDG_SESSION_COOKIE
 113 The unique identifier of the desktop session,
 114 used by the PulseAudio output plugin.
 115
 116 .SH SEE ALSO
 117 Online documentation: http://www.videolan.org/doc/
 118 .PP
 119 .SH AUTHOR
 120 This manual page was written by Sam Hocevar <sam@zoy.org>, for the Debian
 121 GNU/Linux system (but may be used by others).