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.
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)
19 vlc, gvlc, gnome-vlc, qvlc \- The VideoLAN Client
26 This manual page documents briefly the
28 , a free MPEG, MPEG2 and DVD player.
31 recognizes several URL-style items:
36 .B dvd:[<device>][@<raw device>][@[<title>][,[<chapter>][,<angle>]]]
37 DVD device (for instance dvd:/dev/dvd). The raw device is optional and
38 must have been prepared beforehands.
41 VCD device (for instance dvd:/dev/cdrom).
43 .B udpstream:[<server>[:<server port>]][@[<bind address>][:<bind port>]]
44 UDP stream, such as one sent by VideoLAN Server or VideoLAN miniserver.
45 Usually "udpstream:" is enough.
48 Execute a play-list command. Commands are :
52 (pause execution of other items), and
57 follows the usual GNU command line syntax, with long
58 options starting with two dashes (`-').
59 A summary of options is included below.
61 .B \-I, \-\-intf <module>
62 Specify an interface module: "gnome", "curses", "qt", for instance.
67 verbosity. This command is cumulative, you can use "-vv" or "-vvvv" for increased verbosity.
69 .B \-\-memcpy <module>
70 Specify a module for performing heavy memory copies: "memcpy", "sse" for instance.
75 .B \-A, \-\-aout <module>
76 Specify an audio output module: "dsp", "esd", for instance.
78 .B \-\-stereo, \-\-mono
79 Choose stereo or mono audio output.
82 Activate hardware AC3 pass-through mode.
84 .B \-\-downmix <module>
85 Specify a module for AC3 downmix: "downmix", "sse" or "3dn" for instance.
88 Specify a module for AC3 IMDCT: "imdct", sse" or "3dn" for instance.
90 .B \-\-volume [1..1024]
91 Change VLC output volume (default: 512).
93 .B \-\-desync <time in ms>
94 Compensate desynchronization of the audio (default: 0).
99 .B \-V, \-\-vout <module>
100 Specify a video output module: "x11", "sdl", "fb", for instance.
102 .B \-\-motion <module>
103 Specify a module for motion compensation: "motion", "motionmmx", for instance.
106 Specify a module for IDCT: "idct", "idctmmx", for instance.
109 Specify a YUV module: "yuv", "yuvmmx", for instance.
111 .B \-\-display <display>
112 Specify the display name.
114 .B \-\-width <w>, \-\-height <h>
115 Choose the display coordinates.
117 .B \-g, \-\-grayscale
124 Overlay (hardware accelerated output), if available.
126 .B \-\-xvadaptor <port>
127 Select XVideo adaptor, if XVideo output is used.
132 .B \-\-synchro <type>
133 Choose a fixed synchro value instead of the internal auto-adaptative
134 heuristics based on CPU usage.
136 `I' displays only I images, `IP' displays I and P images, `IP+'
137 displays I and P images and every second B image, and `IPB' forces
138 displaying of all images.
140 Note that vlc is not guaranteed to behave properly if you ask it to
141 display more images than your CPU can cope with.
143 .B \-a, \-\-input_audio [ ac3 | lpcm | mpeg | off ]
144 Choose the audio channel type. Most DVDs have AC3 audio channels, but
145 you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
146 not to activate the audio channel.
148 .B \-c, \-\-input_channel [ 0\-15 ]
149 Select the audio channel. Most DVDs only have one or two audio channels,
150 but some of them have a great number of available languages. Note that the
151 audio channel will also depend on the channel type.
153 .B \-s, \-\-input_subtitle [ 0\-31 ]
154 Select the subtitle channel, if there is one in the stream.
156 .B \-\-input <method>
157 Choose the input method, "dvd", "ps", "ts" for instance.
159 .B \-\-nommx, \-\-no3dnow, \-\-nommxext, \-\-nosse, \-\-noaltivec
160 Disable the CPU's MMX, 3D Now!, MMX EXT, SSE or AltiVec support. This may
161 be useful when you suspect a bug in an accelerated module.
167 Print long help and exit.
170 Output version information and exit.
173 also accepts a lot of parameters to customize its behaviour.
175 .B Interface parameters:
176 vlc_intf=<method name> interface method
179 vlc_aout=<method name> audio method
180 vlc_dsp=<filename> dsp device path
181 vlc_stereo={1|0} stereo or mono output
182 vlc_spdif={1|0} AC3 pass-through mode
183 vlc_downmix=<method name> AC3 downmix method
184 vlc_imdct=<method name> AC3 IMDCT method
185 vlc_volume=[0..1024] VLC output volume
186 vlc_audio_rate=<rate> output rate
189 vlc_vout=<method name> display method
190 vlc_display=<display> display used
191 vlc_width=<width> display width
192 vlc_height=<height> dislay height
193 vlc_fb_dev=<filename> framebuffer device
194 vlc_grayscale={1|0} grayscale or color
195 vlc_fullscreen={1|0} full screen
196 vlc_overlay={1|0} overlay
197 vlc_xvport=<port> XVideo port
198 vlc_motion=<method name> motion compensation method
199 vlc_idct=<method name> IDCT method
200 vlc_yuv=<method name> YUV method
201 vlc_synchro={I|I+|IP|IP+|IPB} synchro algorithm
204 vlc_dvd_device=<device> DVD device
205 vlc_input_title=<title> title number
206 vlc_input_chapter=<chapter> chapter number
207 vlc_input_angle=<angle> angle number
208 vlc_input_audio={ac3|lpcm|mpeg|off} audio type
209 vlc_input_channel=[0-15] audio channel
210 vlc_input_subtitle=[0-31] subtitle channel
213 vlc_iface=<interface> network interface
216 .BR vls (1), vlms (1)
219 This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others).