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