* doc/faq/Makefile: added "text" and "clean" targets.
[vlc.git] / doc / faq / faq.sgml
1 <chapter id="faq"><title id="tfaq">FAQ of the VideoLAN Client</title>
2
3 <qandaset><title>FAQ of the VideoLAN Client</title>
4
5 <qandadiv><title>Using the VideoLAN Client</title>
6
7 <qandaentry>
8 <question><para>How do I read a DVD?</para></question>
9 <answer><para>Just launch vlc and use the "open disc" command from the graphical
10 interface. In case of trouble, you may want to use the command line.
11 For instance, provided your DVD device is /dev/dvd:
12
13 <screen><prompt>% </prompt><userinput>vlc dvd:/dev/dvd</userinput></screen>
14
15 </para></answer></qandaentry>
16
17 <qandaentry>
18 <question><para>How do I read an encrypted DVD?</para></question>
19 <answer><para>It is exactly the same as for a normal DVD. You will need write access to
20 /dev/dvd, because of the key negociation process.
21
22 If you compiled your VLC by hand, please bear in mind that you also need
23 to install libdvdcss. It can be downloaded from the VideoLAN website. It
24 used to be distributed in the same package as VLC, but now you must install
25 them seperately.
26
27 </para></answer></qandaentry>
28
29 <qandaentry>
30 <question><para>How do I switch to full screen display?</para></question>
31 <answer><para>Press 'f' to toggle fullscreen mode. Note that not all video output
32 devices support full screen.
33
34 </para></answer></qandaentry>
35
36 <qandaentry>
37 <question><para>How do I hide the mouse cursor?</para></question>
38 <answer><para>It should disappear after a few seconds if you stop moving the mouse.
39
40 </para></answer></qandaentry>
41
42 <qandaentry>
43 <question><para>How do I use vlc if I do not want to install Gnome and
44 all this #@!£% *$@&§% !@# bloat?</para></question>
45 <answer><para>You can run:</para>
46 <screen><prompt>% </prompt><userinput> vlc --intf dummy myfile.mpg</userinput>
47 </screen>
48 <para>Most commands are available from the command line, see <command>vlc
49 --help</command> for more information.</para>
50 </answer></qandaentry>
51
52 <qandaentry>
53 <question><para>VLC eats my buffer cache, how can I use raw device?</para></question>
54 <answer><para>If you do not know what is a raw device, do not even read this answer :-).</para><para>
55 There is an experimental support for raw devices in libdvdcss. It needs
56 that you set up a raw device pointing to your DVD device (under Linux,
57 use the "raw" utility). Then pass the raw device as second argument, for
58 instance:</para>
59 <screen><prompt>% </prompt><userinput>vlc dvd:/dev/dvd@/dev/raw0</userinput></screen>
60 </answer></qandaentry>
61
62 <qandaentry>
63 <question><para>How do I use VLC as a client for VLS/VLMS streaming?</para></question>
64 <answer><para>First you must set up a VLS or VLMS stream. Please refer to the
65 documentation of these programs. Then start VLC:</para>
66
67 <screen><prompt>% </prompt><userinput>vlc udp:</userinput></screen>
68
69 <para>You should not need any option. If you are paranoid and want to control
70 everything, here is the exact syntax:</para>
71
72 <screen><prompt>% </prompt><userinput>vlc udp:[&lt;server&gt;[:&lt;server port&gt;]][@[&lt;bind address&gt;][:&lt;bind port&gt;]]</userinput></screen>
73
74 </answer></qandaentry>
75
76 <qandaentry>
77 <question><para>How do I uninstall / reinstall VLC?</para></question>
78 <answer><para>Why would you want to? ;)</para>
79 <para>
80 If you are using a source distribution of VLC, for example a tarball or
81 the CVS, then you have probably used "make install" to install the
82 compiled VLC. To remove it just "make uninstall". If you want to
83 install a newer version than the currently installed one, you should
84 first uninstall the first one. If you deleted the original source tree,
85 a "make uninstall" in the newer tree should still work.
86 </para><para>
87 For binary packages, remove old packages first and install the new ones
88 (normally this should be handled automagically by your sytem).
89 </para></answer></qandaentry>
90
91 <qandaentry>
92 <question><para>Debian: what should I put in my sources.list for videolan?</para></question>
93 <answer>
94 <programlisting>
95 deb     http://www.videolan.org/pub/videolan/debian $(ARCH)/
96 deb-src http://www.videolan.org/pub/videolan/debian sources/
97 </programlisting>
98
99 </answer></qandaentry>
100
101 <qandaentry>
102 <question><para>How can I save my VLC configuration?</para></question>
103 <answer><para>Currently, the only way to save the configuration options in VLC is through
104 the preferences menu in one of the graphical user interface plugins.
105
106 </para></answer></qandaentry>
107
108 <qandaentry>
109 <question><para>Where does VLC store its config file?</para></question>
110 <answer><para>Currently, a config file is created on a per user basis (there is no global
111 configuration file). If you modify the available options in VLC and save the
112 new configuration, then a configuration file will be created in your user
113 directory. The precise location of this file depends on the Operating System
114 you are running:
115 </para>
116
117 <itemizedlist>
118 <listitem><para>Unices
119 (Linux, etc.): <filename>$(HOME)/.vlc/vlcrc</filename></para></listitem>
120 <listitem><para>Windows: <filename>Application Data\vlc\vlcrc</filename> (Application Data is usually in <filename>C:\Documents and Settings\your_name</filename></para></listitem>
121 <listitem><para>BeOS: <filename>config/settings/vlcrc</filename></listitem>
122 </itemizedlist>
123
124 </answer></qandaentry>
125
126 <qandaentry>
127 <question><para>How do I join an IPv6 multicast stream?</para></question>
128 <answer><para>You often have to indicate the interface name on your system, for instance :
129  udp:@[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210%eth0]:1234
130 </para></answer></qandaentry>
131
132 </qandadiv>
133 <qandadiv><title>Troubleshooting</title>
134
135 <qandaentry>
136 <question><para>When I start vlc, I do not see any interface coming</para></question>
137 <answer><para>If you installed a binary package, make sure you also installed an
138 interface package such as vlc-gtk or vlc-qt. If you installed from
139 source, make sure the development package for gtk or qt is correctly
140 installed (often gtk-dev or gtk-devel) and recompile.
141
142 </para></answer></qandaentry>
143
144 <qandaentry>
145 <question><para>Clicking on "disc" in the interface does not do anything</para></question>
146 <answer><para>Wait a few seconds. Key cracking can take much time on some discs. If it
147 still does not work, you can have a more verbose output using <command>vlc -vvvvv</command>.
148 Here are a few things to check for:
149
150 <itemizedlist>
151 <listitem><para>Did you install the libdvdcss package?</para></listitem>
152
153 <listitem><para>Do you have write access to your DVD device? For instance, under Unix, <command>chmod 666 /dev/hdc</command> </para></listitem>
154
155 <listitem><para>Under Unix, does your kernel log contain line about your DVD device?</para></listitem>
156
157 <listitem><para>Under Unix, do you have a link from /dev/dvd to your real DVD device? For instance</para>
158 <screen><prompt>% </prompt><userinput>ln -s hdc /dev/dvd</userinput></screen></listitem>
159 </itemizedlist>
160
161 </para></answer></qandaentry>
162
163 <qandaentry>
164 <question><para>[REMOVED]</para></question>
165 </qandaentry>
166
167 <qandaentry>
168 <question><para>The video runs but the picture is distorted</para></question>
169 <answer><para>There is probably a problem with the output layer. There are several
170 ways of troubleshooting it. First, try with another output plugin, for
171 instance:</para>
172
173 <screen>
174 <prompt>% </prompt><userinput>vlc --vout sdl</userinput>
175 <prompt>% </prompt><userinput>vlc --vout x11</userinput>
176 </screen>
177
178 <para>Second, change your screen depth and/or definition. It quite often helps.
179 Lastly, if running Unix, have a look at your XFree86 video driver (nVidia for instance
180 releases optimized drivers for its boards).
181 </para></answer></qandaentry>
182
183 <qandaentry>
184 <question><para>Video is choppy</para></question>
185 <answer><para>Your system is too slow to decode all pictures. It might be that your CPU basically is not fast enough. It can also be that the subsystem is
186 misconfigured/misdriven, this happens for example under Redhat Linux. Here are
187 some elements to improve speed:
188 </para>
189
190 <itemizedlist>
191 <listitem><para>Turn on DMA on your DVD device, for instance</para>
192 <screen><prompt>Under Linux:      % </prompt><userinput>hdparm -X34 -d1 /dev/dvd</userinput></screen>
193
194 <para>Under Windows,  go to  the <emphasis>System</emphasis>  section of
195 the control  panel, and go to  the <emphasis>Hardware manager</emphasis>
196 (it is sometimes in a separate tab, and sometimes, you have to go to the
197 <emphasis>Advanced</emphasis> tab.  Then, righ-click on your  DVD player,
198 and check the <emphasis>DMA</emphasis> checkbox</para></listitem>
199
200 <listitem><para>Upgrade to the latest driver for your
201 video board</para>
202 <para>If you are running Linux, you can additionnaly upgrade to the latest XFree86 version ; if supported, check that the xvideo plug-in is effectively used with</para>
203 <screen><prompt>% </prompt><userinput>vlc -vvvv</userinput></screen>
204 </listitem>
205
206 <listitem><para>Kill other applications running...</para></listitem>
207 </itemizedlist>
208 </answer></qandaentry>
209
210 <qandaentry>
211 <question><para>Audio is choppy</para></question>
212 <answer><para>This is not normal; it is a known problem and is being investigated.
213
214 </para></answer></qandaentry>
215
216 <qandaentry>
217 <question><para>Audio and video are out of sync</para></question>
218 <answer><para>This is not normal. Try using another output plugin (for instance <command>--aout dsp</command>),
219 kill <emphasis>esd</emphasis> or <emphasis>artsd</emphasis> if they are running. This is a known problem and is being investigated.
220
221 </para></answer></qandaentry>
222
223 <qandaentry>
224 <question><para>[REMOVED]</para></question>
225 </qandaentry>
226
227 <qandaentry>
228 <question><para>Sound volume is too low</para></question>
229 <answer><para>You can raise it with <command>--volume</command> command line switch or in the preferences
230 window of your graphical interface.
231
232 </para></answer></qandaentry>
233
234 <qandaentry>
235 <question><para>I have no image under DirectX</para></question>
236 <answer><para>Check that your video card drivers are in their latest version and that
237 your DirectX is up-to-date.
238
239 </para></answer></qandaentry>
240
241 <qandaentry>
242 <question><para>VLC crashes</para></question>
243 <answer><para>Increase the verbosity level (either in the preferences or with a
244 <emphasis>-vv</emphasis> command line option) and look at the debug messages (in the
245 terminal or in the Messages window).
246
247 </para></answer></qandaentry>
248
249 <qandaentry>
250 <question><para>Under Unices, i can only play a DVD as root</para></question>
251 <answer><para>Check that as user you have write access to your DVD drive / device.
252
253 </para></answer></qandaentry>
254
255 <qandaentry>
256 <question><para>I am stuck with option xxx, how do I reset options?</para></question>
257 <answer><para>Under unices, remove your <filename>~/.vlc/vlcrc</filename>; for Windows, remove <filename>vlcrc</filename>
258 in the videolan subfolder of your <filename>Application Data</filename> directory.
259
260 </para></answer></qandaentry>
261
262 <qandaentry>
263 <question><para>I do not have access to the GUI anymore</para></question>
264 <answer><para>If you change the default interface module in the preferences menu to a non
265 GUI module (ie. to a command line interface) and then save the configuration,
266 the only way to get VLC to show a GUI again is to run it directly from the
267 command line.</para><para>
268 For instance on Windows, you need to open a Command Line console, go to the
269 directory where you installed VLC (usually
270 <filename>C:\Program Files\VideoLAN\VideoLAN Client</filename>) and then type <command>vlc --intf win32</command>
271 You will then be able to modify the configuration again and save it.
272
273 </para></answer></qandaentry>
274
275 <qandaentry>
276 <question><para>I have just upgraded to VLC 0.4.5, and now I do not have any sound with the streams coming from the VLS!</para></question>
277 <answer><para>This is a known problem. VLC 0.4.5 and later are now compliant to general
278 usage regarding A/52 sound, and the new behavior is incompatible with the
279 previous one. VLS version 0.4.0 and later now fixes this problem. If, for
280 any reason, you wish to keep VLS 0.3.3, you can still read those streams by
281 launching VLC (0.4.5 or later) with <command>--vls-backwards-compat</command>.
282
283 </para></answer></qandaentry>
284
285 <qandaentry>
286 <question><para>NO VIDEO!! or NO AUDIO!!</para></question>
287 <answer><para>DON'T PANIC! Use the verbose mode of vlc to search the problem, you may
288 either set the verbosity option in the interface preferences or use
289 the "-v" command line switch to increase the number of report/error
290 messages given by vlc. If you are not using a terminal, use the Messages
291 window in the View menu.
292 </para></answer></qandaentry>
293
294 </qandadiv>
295 <qandadiv><title>Ports and features</title>
296
297 <qandadiv><title>MacOS X port</title>
298
299 <qandaentry>
300 <question><para>Does VLC support the ATI DVD hardware acceleration cards?</para></question>
301 <answer><para>Currently it does not. We would be glad to support them, but we lack technical
302 information on them.
303
304 </para></answer></qandaentry>
305
306 <qandaentry>
307 <question><para>[REMOVED]</para></question>
308 </qandaentry>
309
310 </qandadiv>
311
312 <qandadiv><title>Win32 port</title>
313
314 <qandaentry>
315 <question><para>When moving the focus to another window, VLC network input stops working properly!</para></question>
316 <answer><para>This is a known problem with Win 95-class systems (ie, Windows 95/98/Me). Upgrade to an NT-class system (ie, Windows NT/2000 or XP).
317 </para></answer></qandaentry>
318
319 </qandadiv>
320
321 <qandadiv><title>Planned ports</title>
322
323 <qandaentry>
324 <question><para>Do you have plans for a MacOS 9 / OS/2 / &{#!@}~ port?</para></question>
325 <answer><para>No, nobody reported to be actually working on a MacOS 9 port. If you
326 feel like you could write it, we would of course welcome it. Currently,
327 the developers are more interested in supporting the latest Operating
328 Systems and completing the functionalities.
329 </para></answer></qandaentry>
330
331 <qandaentry>
332 <question><para>Does VLC have dxr2 / dxr3 cards support?</para></question>
333 <answer><para>This support is currently being developed.
334 </para></answer></qandaentry>
335
336 <qandaentry>
337 <question><para>Does VLC support RTP?</para></question>
338 <answer><para>Yes. Just use vlc rtp:@&lt;mcast addr&gt;:&lt;local port&gt;.
339 </para></answer></qandaentry>
340
341 <qandaentry>
342 <question><para>Does VLC support DVD from all regions?</para></question>
343 <answer><para>VLC uses libdvdcss to read all DVD, disregarding their zone. All regions
344 are supported without any constraint. However, libdvdcss might not be
345 legal in your country.
346 </para></answer></qandaentry>
347
348 <qandaentry>
349 <question><para>How can I take screenshots?</para></question>
350 <answer><para>This is currently unsupported, but will be in a near future. The latest
351 developments concern recording the video and the audio to a file.
352 However, under XFree, you may use the "x11" video output to take normal
353 screen capture of the video displayed by vlc.
354 </para></answer></qandaentry>
355
356 </qandadiv>
357
358 </qandadiv>
359
360 <qandadiv><title>Legal concerns</title>
361
362 <qandaentry>
363 <question><para>May I use the VideoLAN logo?</para></question>
364 <answer><para>You may freely use the VideoLAN logo using the following copyright:
365 <emphasis>
366   Copyright (c) 1996-2002 VideoLAN. This logo or a modified version
367   may be used or modified by anyone to refer to the VideoLAN project
368   or any product developed by the VideoLAN team, but does not indicate
369   endorsement by the project.
370 </emphasis>
371 </para></answer></qandaentry>
372
373 <qandaentry>
374 <question><para>May I redistribute VLC?</para></question>
375 <answer><para>You may distribute an original or modified version of VideoLAN as long
376 as you comply with its license terms. It is the GNU General Public
377 License Version 2 (referred herein as GPL), and it is in the file named
378 COPYING in our products.
379 The easiest way to conform to the GPL is to accompany the product you
380 want to distribute with its sources. For example, if you plan to
381 distribute the 0.4.6 binary version you should include:
382 </para>
383 <programlisting>
384    http://www.videolan.org/pub/videolan/vlc/0.4.6/vlc-0.4.6.tar.gz
385    http://www.videolan.org/pub/videolan/vlc/0.4.6/contrib/
386 </programlisting><para>
387 You do not need to bother explaining where the sources are, but the
388 sources have to share the same media as the products.
389 </para><para>
390 They are other ways to comply with the GPL, but this should be the
391 simplest because it does not rely on a contract.
392 </para><para>
393 There is one additional issue you need to take care of. The VLC
394 binary from our website can also read encrypted DVDs with the help of
395 the libdvdcss library. Its use is controversial in a few countries
396 such as the United States because of a law called the DMCA. If you are
397 unsure about the legality of using and distributing this library in
398 your country, please consult your lawyer.
399 </para></answer></qandaentry>
400 </qandadiv>
401
402 <qandadiv><title>Miscellaneous</title>
403
404 <qandaentry>
405 <question><para>How may I help your project?</para></question>
406 <answer><para>You might either contribute time, material, or money. We are also always
407 needing some translators. You will find all information you need at
408 <ulink url="http://www.videolan.org/contribute.html">http://www.videolan.org/contribute.html</ulink>.
409 </para></answer></qandaentry>
410
411
412 <qandaentry>
413 <question><para>Why are your mailing-lists and your website in english?</para></question>
414 <answer><para>VideoLAN's developers come from all around the world and english is
415 the only language they can use to communicate together. Although great
416 care is given to the translation of our software in various languages,
417 maintaining translations of our documentation and website costs too much
418 more time than we can afford.
419 </para></answer></qandaentry>
420
421 </qandadiv>
422 </qandaset>
423 </chapter>