git.sesse.net Git - vlc/blob - 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 "March 10, 2001"
   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, gvlc, gnome-vlc, kvlc, qvlc \- The VideoLAN Client
  20 .SH SYNOPSIS
  21 .B vlc
  22 .RI [ OPTIONS ]
  23 .RI [ PARAMETERS ]
  24 .RI [ FILE ]...
  25 .SH DESCRIPTION
  26 This manual page documents briefly the
  27 .B vlc
  28 , a free MPEG, MPEG2 and DVD player.
  29 .SH OPTIONS
  30 .B vlc
  31 follows the usual GNU command line syntax, with long
  32 options starting with two dashes (`-').
  33 A summary of options is included below.
  34 .TP
  35 .B \-I, \-\-intf <module>
  36 Specify an interface module: "gnome", "curses", "qt", for instance.
  37 .TP
  38 .B \-v, \-\-verbose
  39 Set
  40 .B vlc
  41 verbosity. This command is cumulative, you can use "-vv" or "-vvvv" for increased verbosity.
  42 .TP
  43 .B \-\-noaudio
  44 Disable audio output.
  45 .TP
  46 .B \-A, \-\-aout <module>
  47 Specify an audio output module: "dsp", "esd", for instance.
  48 .TP
  49 .B \-\-stereo, \-\-mono
  50 Choose stereo or mono audio output.
  51 .TP
  52 .B \-\-spdif
  53 Activate hardware AC3 pass-through mode.
  54 .TP
  55 .B \-\-downmix <module>
  56 Specify a module for AC3 downmix: "downmix", "downmixsse", for instance.
  57 .TP
  58 .B \-\-imdct <module>
  59 Specify a module for AC3 IMDCT: "imdct", "imdctsse", for instance.
  60 .TP
  61 .B \-\-novideo
  62 Disable video output.
  63 .TP
  64 .B \-V, \-\-vout <module>
  65 Specify a video output module: "x11", "sdl", "fb", for instance.
  66 .TP
  67 .B \-\-motion <module>
  68 Specify a module for motion compensation: "motion", "motionmmx", for instance.
  69 .TP
  70 .B \-\-idct <module>
  71 Specify a module for IDCT: "idct", "idctmmx", for instance.
  72 .TP
  73 .B \-\-yuv <module>
  74 Specify a YUV module: "yuv", "yuvmmx", for instance.
  75 .TP
  76 .B \-\-display <display>
  77 Specify the display name.
  78 .TP
  79 .B \-\-width <w>, \-\-height <h>
  80 Choose the display coordinates.
  81 .TP
  82 .B \-g, \-\-grayscale
  83 Grayscale output.
  84 .TP
  85 .B \-\-fullscreen
  86 Full screen output.
  87 .TP
  88 .B \-\-overlay
  89 Overlay (hardware accelerated output), if available.
  90 .TP
  91 .B \-\-color
  92 Color output.
  93 .TP
  94 .B \-\-synchro <type>
  95 Choose a fixed synchro value instead of the internal auto-adaptative
  96 heuristics based on CPU usage.
  97
  98 `I' displays only I images, `IP' displays I and P images, `IP+'
  99 displays I and P images and every second B image, and `IPB' forces
 100 displaying of all images.
 101
 102 Note that vlc is not guaranteed to behave properly if you ask it to
 103 display more images than your CPU can cope with.
 104 .TP
 105 .B \-t, \-\-dvdtitle <title>
 106 Choose the DVD title. Most movies on DVDs start on the first title, but you may want to manually select another title.
 107 .TP
 108 .B \-T, \-\-dvdchapter <title>
 109 Choose the DVD chapter. DVDs are divided into titles, which in turn are divided into chapters.
 110 .TP
 111 .B \-a, \-\-dvdaudio [ ac3 | lpcm | mpeg | off ]
 112 Choose the audio channel type. Most DVDs have AC3 audio channels, but
 113 you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
 114 not to activate the audio channel.
 115 .TP
 116 .B \-c, \-\-dvdchannel [ 0\-15 ]
 117 Select the audio channel. Most DVDs only have one or two audio channels,
 118 but some of them have a great number of available languages. Note that the
 119 audio channel will also depend on the channel type.
 120 .TP
 121 .B \-s, \-\-dvdsubtitle [ 0\-31 ]
 122 Select the subtitle channel, if there is one in the stream.
 123 .TP
 124 .B \-\-input <method>
 125 Choose the input method, "dvd", "ps", "ts" for instance.
 126 .TP
 127 .B \-\-vlans
 128 Enable VLANs support. This feature isn't activated yet.
 129 .TP
 130 .B \-\-server <host>, \-\-port <port>
 131 Choose the video server address and port.
 132 .TP
 133 .B \-\-broadcast
 134 Set broadcast mode for network input.
 135 .TP
 136 .B \-h, \-\-help
 137 Print help and exit.
 138 .TP
 139 .B \-H, \-\-longhelp
 140 Print long help and exit.
 141 .TP
 142 .B \-\-version
 143 Output version information and exit.
 144 .SH PARAMETERS
 145 .B vlc
 146 also accepts a lot of parameters to customize its behaviour.
 147 .TP
 148 .B Interface parameters:
 149  vlc_intf=<method name>   interface method
 150  vlc_init=<filename>      initialization script
 151  vlc_channels=<filename>  channels list
 152 .TP
 153 .B Audio parameters:
 154  vlc_aout=<method name>         audio method
 155  vlc_dsp=<filename>             dsp device path
 156  vlc_stereo={1|0}               stereo or mono output
 157  vlc_spdif={1|0}                AC3 pass-through mode
 158  vlc_downmix=<method name>      AC3 downmix method
 159  vlc_imdct=<method name>        AC3 IMDCT method
 160  vlc_audio_rate=<rate>          output rate
 161 .TP
 162 .B Video parameters:
 163  vlc_vout=<method name>        display method
 164  vlc_display=<display>         display used
 165  vlc_width=<width>             display width
 166  vlc_height=<height>           dislay height
 167  vlc_fb_dev=<filename>         framebuffer device
 168  vlc_grayscale={1|0}           grayscale or color
 169  vlc_fullscreen={1|0}          full screen
 170  vlc_overlay={1|0}             overlay
 171  vlc_motion=<method name>      motion compensation method
 172  vlc_idct=<method name>        IDCT method
 173  vlc_yuv=<method name>         YUV method
 174  vlc_synchro={I|I+|IP|IP+|IPB} synchro algorithm
 175 .TP
 176 .B DVD parameters:
 177  vlc_dvd_device=<device>           DVD device
 178  vlc_input_title=<title>           title number
 179  vlc_input_chapter=<chapter>       chapter number
 180  vlc_audio={ac3|lpcm|mpeg|off}     audio type
 181  vlc_channel=[0-15]                audio channel
 182  vlc_subtitle=[0-31]               subtitle channel
 183 .TP
 184 .B Input parameters:
 185  vlc_server=<hostname>    video server
 186  vlc_server_port=<port>   video server port
 187  vlc_broadcast={1|0}      broadcast mode
 188  vlc_iface=<interface>    network interface
 189  vlc_vlan_server=<host>   vlan server
 190  vlc_vlan_port=<port>     vlan server port
 191
 192 .SH SEE ALSO
 193 .BR vls (1), vlms (1)
 194 .br
 195 .SH AUTHOR
 196 This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others).