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