diff --git a/doc/vlc-howto.sgml b/doc/vlc-howto.sgml
index aea356bd1f..7746ead79b 100644
@@ -2,11 +2,11 @@
- by the Videolan Team
+ Originally written by Henri Fallon, maintained by Johan Bilienv0.0.9, 16 april 2002
- This document describes how to use the vlc (VideoLAN client) to read DVDs and mpeg files and DVDs.
+ This document describes how to use the vlc (VideoLAN client) to read DVDs and mpeg files, locally or from a network.
@@ -19,11 +19,11 @@
What is VideoLAN ?
VideoLAN is a project of sudents of the École Centrale Paris which aims
- to broadcast video on the campus, and provide the students with a MPEG2
+ at broadcasting video on the campus, and providing the students with an MPEG-2
software-only decoder. VideoLAN is an OpenSource project which will thus
allow anyone to watch DVD movies under Linux, BeOS, MacOS X, Windows
- and most Unix
+ and most UNIX systems. Recent additions allow to read .avi files,
+ and MPEG-4/DivX-encoded movies.
You may want to look at the port section on our website :
@@ -32,14 +32,64 @@
- What is the vlc
+ What is the VideoLAN project ?
- Vlc stands for VideoLAN client. It is the name of the program which is
- capable of decoding MPEG streams, and displaying them onto your screen,
- so you can watch you favourite movies, confortably sit in your armchair
+ VideoLAN is a complete software solution for video streaming, developed
+ by students at the and contributors from all over the world, under the . It has been designed for streaming MPEG 1 and MPEG 2 videos on
+ local area networks (LAN), but it can be extended to metropolitan or
+ wide area networks (MAN, WAN), thanks to the multicast technology.
+ The VideoLAN solution includes a server, which can stream video from
+ various sources (file, DVD, satellite and MPEG 2 encoder), a client, which can
+ receive, decode and display MPEG 1 and MPEG 2 streams and, if necessary,
+ a channel server which tells automatically to the client the parameters
+ needed to receive the stream.
+ Here is an illustration of the complete VideoLAN solution :
+ DVD --->- Unicast/Broadcast/Multicast
+ \ ---
+ File --->-- -------- / \ --------
+ |->-| Server |=====>====| LAN |---->-----| Client |
+ Satellite ->-- | (VLS) | \ / | (VLC) |
+ / -------- --- --------
+ MPEG2 -->- ^
+ encoder |
+ | Channel Server |
+ | (VLCS) |
+ More details about the project can be found on the
+ The documentation of the project
+ There are four main documents :
+this VideoLAN Client Howto.
+The up-to-date version of these documents can be found on the .
Translated versions of this document
@@ -55,6 +105,57 @@
+ Operating system
+ VLC works under the following systems :
+ Linux (all distributions, including iPAQ Familiar Linux)
+ Windows (all 32bit versions)
+ Mac OS X
+ FreeBSD, NetBSD, OpenBSD, BSD/OS
+ QNX RTOS
+ Please note that the Linux, Windows and MacOS X versions are generally the most
+ up-to-date ones.
+ Software requirements
+ Depending on the outputs and inputs you are using, you may need
+ additional libraries. Please see .
+ For playing encrypted DVDs, you will need libdvdcss, which you can find
+ on this page :
+ Hardware requirements
+ The hardware power needed depends a lot of the type of stream.
+ For reading a DVD, a CPU working at around 450 MHz is required.
+ VLC can benefits from hardware acceleration from modern video cards
+ for YUV transformation and window rescaling. it also uses MMX, MMX EXT,
+ SSE, 3Dnow! optimizations if available.
@@ -63,19 +164,28 @@
- In this HOWTO, we consider you already have a little knowledge about
- Linux, and you know how to use a DVD. If not, good howtos can be
- found on the Linux Documentation Projet.
+ In this HOWTO, we consider you already have a little knowledge
+ about Linux, and you know how to use a DVD. If not, good howtos
+ can be found on the .
There are different packages because vlc has "plugins" which provide
- features but also enlarge the executable and require external libs.
+ features but also enlarge the executable and require external libraries.
SDL is a lib which allows you to have an accelerated video output.
@@ -124,20 +234,20 @@
Depending on the package you have downloaded, you may have dependency
- problems. You have to solve them, by installing the required libs.
+ problems. You have to solve them, by installing the required libraries.
- Install vlc just as you would install any rpm package :
+ Install vlc just as you would install any RPM package :
rpm -i vlc-x.x.x.rpm
- You may have to install external libs to meet dependencies, depending on
+ You may have to install external libraries to meet dependencies, depending on
the package you downloaded (gnome, gtk, esd, ...).
@@ -147,21 +257,23 @@
Double-click on the archive. It should open your favorite archive extracter.
You can then execute the vlc from there, or extract the archive to a
- diretory and run it from there.
+ directory and run it from there.
- MacOS X users
+ Mac OS X users
- To be completed
+ Double-click on the archive, and copy the vlc file to your Applications
- Decompress the archive with your favourite extracter in a directory of your
+ Launch the installer by double-clicking on it, and follow the installation
+ instructions. Please note that in most cases you will need administrator
+ rights to install it under Windows NT, 2000 and XP.
+ For Windows, BeOS and Mac OS X users, libdvdcss is statically linked in the
+ Windows binary, so you don't have to install it.
@@ -192,7 +308,7 @@
- Usually, you dvd device is /dev/hd? (if you have an ide drive).
+ Usually, your dvd device is /dev/hd? (if you have an ide drive).
For instance, if you DVD player is master on the second IDE device,
it will be /dev/hdc.
@@ -209,7 +325,7 @@
- The path to your DVD drive usually is D: or E:. You may have a look
+ The path to your DVD drive usually is D:\ or E:\. You may have a look
in "My Computer" and look to which letter your DVD drive is assigned.
@@ -252,16 +368,16 @@
- If nothing appears and you are sure that a program is broadcasted in
+ If nothing appears and you are sure that a program is streamed in
this channel, you may try once again, because a problem of communication
- with the channel server could have occured (in you launched vlc from
+ with the channel server could have occurred (if you launched vlc from
a terminal, you should see "Network error: no answer from vlcs").
Without VideoLAN Channel Server
- Simply choose clicking on the network button, then on ok should be
+ Simply clicking on the network button, then on ok should be
sufficient in most cases.
@@ -328,7 +444,7 @@
In every tab, you may click on "Save" to store your settings in your
- ~/.videolan/vlrrc file.
+ ~/.videolan/vlcrc file.
@@ -394,7 +510,7 @@
Command line options
- Many options are only available through command line. They are detailled here.
+ Many options are only available through command line. They are detailed here.
@@ -436,6 +552,8 @@
vlc udpstream: should be sufficient. If the stream
is multicasted, you must specify the multicast address, for example
+ To receive a http stream, start vlc with vlc <your URL>.
@@ -453,9 +571,6 @@
--intf <interface module>
allows you to select the interface module
--input <input module>
- allows you to select the input module.
--vout <video output module>
allows you to select the video output.
@@ -465,10 +580,10 @@
--filter <video filter module>
allows you to add a video filter module.
--mpeg_adec <MPEG audio decoder module>
--mpeg-adec <MPEG audio decoder module>
allows you to select the audio MPEG decoder.
--ac3_adec <AC3 audio decoder module>
--ac3-adec <AC3 audio decoder module>
allows you to select the audio AC3 decoder.
@@ -485,9 +600,9 @@
gives you information about the current version.
gives you the list of all available plugins.
--warning X or -vvvv (X times)
-vvvv (X times)
set the level of warning messages.
gives statistic outputs.
@@ -531,28 +646,28 @@
Start with channel server enabled.
Specify the channel server address.
Specify the channel server port.
Select the network interface to use.
Select the program to use (for streams with
several programs, as those coming from satellite).
Select the audio channel to use.
Select the subtitle.
Select the channel number.
Specify the default dvd device.
Specify the default vcd device.
@@ -613,7 +728,7 @@
Directly from CVS
@@ -731,7 +846,7 @@
This is the basic x11 video output. It only requires a
working X11 server. You will need xlibs headers to compile it
- (xlibs-dev packet on Debian systems).
+ (xlibs-dev package on Debian systems).
@@ -822,7 +937,7 @@
- This filter deinterlaces video. It is usefull with streams coming
+ This filter deinterlaces video. It is useful with streams coming
from a satellite broadcast.
@@ -937,6 +1052,13 @@
This is the VideoCD input.
+ This is the http input. You can use it for Video On Demand.
@@ -947,6 +1069,14 @@
+ This input module allows to read .avi files.
@@ -1025,6 +1155,28 @@
+ Codec modules
The following modules add codec support.
+ This is a better AC3/A52 decoder than the built-in one, based on
+ liba52 :
+ This is a free MPEG-4/DivX/OpenDivX codec :
OS support modules
The following modules add support or different OSs.
@@ -1136,8 +1288,8 @@
Get more help
First of all, it something seems to go wrong, read and try to
- understand the error messages. If you are a confirmed user, you
- may try the "-vvv" option which makes the vlc very verbose.
+ understand the error messages. You can have detailed messages by
+ choosing messages in the view menu, in GTK, Gnome and Win32 interfaces.
There is a FAQ page on our website :
@@ -1146,7 +1298,7 @@
- Finally, there's a users mailing list (English speaking). To subscribe, send a mail to
+ Finally, there's a users mailing list (English-speaking). To subscribe, send a mail to
"subscribe vlc" as message body.