b33f5fcb310ac1075c3a2341f6efc5e4e1a7e338
[vlc.git] / 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, qvlc \- The VideoLAN Client
20 .SH SYNOPSIS
21 .B vlc
22 .RI [ OPTIONS ]
23 .RI [ PARAMETERS ]
24 .RI [ ITEMS ]...
25 .SH DESCRIPTION
26 This manual page documents briefly the
27 .B vlc
28 , a free MPEG, MPEG2 and DVD player.
29 .SH ITEMS
30 .B vlc
31 recognizes several URL-style items:
32 .TP
33 .B *.mpg, *.vob
34 Plain MPEG-1/2 files
35 .TP
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.
39 .TP
40 .B vcd:<device>
41 VCD device (for instance dvd:/dev/cdrom).
42 .TP
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.
46 .TP
47 .B vlc:<command>
48 Execute a play-list command. Commands are :
49 .B loop
50 (loop the playlist),
51 .B pause
52 (pause execution of other items), and
53 .B quit
54 (close VLC).
55 .SH OPTIONS
56 .B vlc
57 follows the usual GNU command line syntax, with long
58 options starting with two dashes (`-').
59 A summary of options is included below.
60 .TP
61 .B \-I, \-\-intf <module>
62 Specify an interface module: "gnome", "curses", "qt", for instance.
63 .TP
64 .B \-v, \-\-verbose
65 Set
66 .B vlc
67 verbosity. This command is cumulative, you can use "-vv" or "-vvvv" for increased verbosity.
68 .TP
69 .B \-\-memcpy <module>
70 Specify a module for performing heavy memory copies: "memcpy", "sse" for instance.
71 .TP
72 .B \-\-noaudio
73 Disable audio output.
74 .TP
75 .B \-A, \-\-aout <module>
76 Specify an audio output module: "dsp", "esd", for instance.
77 .TP
78 .B \-\-stereo, \-\-mono
79 Choose stereo or mono audio output.
80 .TP
81 .B \-\-spdif
82 Activate hardware AC3 pass-through mode.
83 .TP
84 .B \-\-downmix <module>
85 Specify a module for AC3 downmix: "downmix", "sse" or "3dn" for instance.
86 .TP
87 .B \-\-imdct <module>
88 Specify a module for AC3 IMDCT: "imdct", sse" or "3dn"  for instance.
89 .TP
90 .B \-\-volume [1..1024]
91 Change VLC output volume (default: 512).
92 .TP
93 .B \-\-desync <time in ms>
94 Compensate desynchronization of the audio (default: 0).
95 .TP
96 .B \-\-novideo
97 Disable video output.
98 .TP
99 .B \-V, \-\-vout <module>
100 Specify a video output module: "x11", "sdl", "fb", for instance.
101 .TP
102 .B \-\-motion <module>
103 Specify a module for motion compensation: "motion", "motionmmx", for instance.
104 .TP
105 .B \-\-idct <module>
106 Specify a module for IDCT: "idct", "idctmmx", for instance.
107 .TP
108 .B \-\-yuv <module>
109 Specify a YUV module: "yuv", "yuvmmx", for instance.
110 .TP
111 .B \-\-display <display>
112 Specify the display name.
113 .TP
114 .B \-\-width <w>, \-\-height <h>
115 Choose the display coordinates.
116 .TP
117 .B \-g, \-\-grayscale
118 Grayscale output.
119 .TP
120 .B \-\-fullscreen
121 Full screen output.
122 .TP
123 .B \-\-overlay
124 Overlay (hardware accelerated output), if available.
125 .TP
126 .B \-\-xvadaptor <port>
127 Select XVideo adaptor, if XVideo output is used.
128 .TP
129 .B \-\-color
130 Color output.
131 .TP
132 .B \-\-synchro <type>
133 Choose a fixed synchro value instead of the internal auto-adaptative
134 heuristics based on CPU usage.
135
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.
139
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.
142 .TP
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.
147 .TP
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.
152 .TP
153 .B \-s, \-\-input_subtitle [ 0\-31 ]
154 Select the subtitle channel, if there is one in the stream.
155 .TP
156 .B \-\-input <method>
157 Choose the input method, "dvd", "ps", "ts" for instance.
158 .TP
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.
162 .TP
163 .B \-h, \-\-help
164 Print help and exit.
165 .TP
166 .B \-H, \-\-longhelp
167 Print long help and exit.
168 .TP
169 .B \-\-version
170 Output version information and exit.
171 .SH PARAMETERS
172 .B vlc
173 also accepts a lot of parameters to customize its behaviour.
174 .TP
175 .B Interface parameters:
176  vlc_intf=<method name>   interface method
177 .TP
178 .B Audio parameters:
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
187 .TP
188 .B Video parameters:
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
202 .TP
203 .B DVD parameters:
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
211 .TP
212 .B Input parameters:
213  vlc_iface=<interface>    network interface
214
215 .SH SEE ALSO
216 .BR vls (1), vlms (1)
217 .br
218 .SH AUTHOR
219 This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others).