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