Commit e90ac92f authored by Alexis de Lattre's avatar Alexis de Lattre

Various enhacements.

Please use 'VLC', not 'the VLC' !
parent 14dd0e83
<para>The VideoLAN Client is a multi-OS software. There are binaries
<para>The VideoLAN Client (VLC) is a multi-OS software. There are binaries
versions available for the main ones, but for some other OS, you will
have to compile the source code by yourself. Anyway, you can compilate
the VLC for every OS, if you want to change the default settings, for
......@@ -8,11 +8,11 @@ exemple</para>
<sect2><title>Under Windows</title>
<para>
The VideoLAN Client works under Windows 95/98/ME/2000/XP. Download
VLC works under Windows 95/98/ME/2000/XP. Download
the Windows Installer or the Zip file from the <ulink
url="http://www.videolan.org/vlc/download-windows.html">VLC Windows download
page</ulink>. Execute the Windows installer or unzip the file in a
directory to install the VideoLAN Client.
directory to install VLC.
</para>
</sect2>
......@@ -44,17 +44,17 @@ window to the place where you want to install it (it should be
</sect2>
<sect2><title>Under Linux Debian</title>
<para>You can use the very powerful tool <command>apt-get</command>
<para>
Edit, as root /etc/apt/sources.list and add the following lines :
</para>
<para>Edit as root <filename>/etc/apt/sources.list</filename> and add
the following lines :</para>
<programlisting>
deb http://www.videolan.org/pub/videolan/debian $(ARCH)/
deb-src http://www.videolan.org/pub/videolan/debian sources/
</programlisting>
<para>
Then install the packages :
</para>
<para>Then install the packages :</para>
<screen>
<prompt># </prompt><userinput>apt-get update</userinput>
<prompt># </prompt><userinput>apt-get install vlc-gnome vlc-mad libdvdcss2</userinput>
......@@ -93,10 +93,9 @@ libdvdcss2-version.i586.rpm libdvdpsi1-version.i586.rpm</userinput>
<sect2><title>Compile the sources by yourself (for every other OS)</title>
<para>The method below is for any Unix system supported by the
VideoLAN Client,for which there is no packages available. It explains
how to compile and install VLC and the needed librairies from their
source code.</para>
<para>The method below is for any Unix system supported by VLC, for
which there is no packages available. It explains how to compile and
install VLC and the needed librairies from their source code.</para>
<para>You can also compile the VLC under Linux this way if you want to
modify the default supported modules</para>
......@@ -107,15 +106,24 @@ Many libraries are needed for particular uses :
</para>
<itemizedlist>
<listitem><para><emphasis>libdvdcss</emphasis> if you want to be able to
read encrypted DVDs,</para></listitem>
<listitem><para><emphasis>libdvdplay</emphasis> if you want to have DVD
menu navigation,</para></listitem>
<listitem><para><emphasis>libdvbpsi</emphasis> if you want to be able to
read from the network,</para></listitem>
<listitem><para><emphasis>liba52</emphasis> if you want to be able to
decode the AC3 (i.e. A52) sound format often used in DVDs,</para></listitem>
<listitem><para><emphasis>liba52</emphasis> if you want to be
able to decode the AC3 (i.e. A52) sound format often used in
DVDs,</para></listitem>
<listitem><para><emphasis>ffmpeg</emphasis> and
<emphasis>libmad</emphasis> if you want to read MPEG 4 / DivX
files.</para></listitem>
</itemizedlist>
<para>
......@@ -151,7 +159,7 @@ contains the following line :
</sect3>
<sect3><title>Install the VideoLAN Client</title>
<sect3><title>Install VLC</title>
<para>
Download the sources of the lastest release : get the file
......@@ -173,10 +181,10 @@ Download the sources of the lastest release : get the file
<para>Please note that all the modules are described in
the <emphasis>Modules</emphasis> section of the <ulink
url="http://www.videolan.org/doc/vlc-user-guide/">VLC User
Guide</ulink></para>
Guide</ulink>.</para>
<para>Exemples of very simple configurations:</para>
<para>Examples of very simple configurations:</para>
<itemizedlist>
<listitem><para>if you want a basic VLC, do : </para>
......@@ -205,15 +213,9 @@ Then, compile and install :
<prompt># </prompt><userinput>make install</userinput>
</screen>
<para>Please note that the installation (make install command) is not
mendatory. You can execute the VideoLAN Client from where you compiled
it</para>
<para> To uninstall the VLC, you can also do a <command>make
uninstall</command>, <command>make clean</command> or <command>make
distclean</command> as needed.
</para>
<para>Please note that the installation (<command>make install</command>
command) is not mandatory. You can execute VLC from where you compiled
it.</para>
</sect3>
</sect2>
......@@ -194,7 +194,7 @@ document contains Frequently Asked Questions of VLC users.</para>
<para>
The up-to-date version of these documents can be found on the <ulink
The latest version of these documents can be found on the <ulink
url="http://www.videolan.org/doc/">VideoLAN Web site</ulink>.
</para>
......@@ -229,19 +229,30 @@ mailing-list page</ulink>.
</para>
<para>You can also talk with VideoLAN users and developers on IRC :
server <emphasis>irc.freenode.net</emphasis>, channel
<emphasis>#videolan</emphasis>.</para>
<para>If you find a bug, please follow the instructions on the <ulink
url="http://www.videolan.org/support/bug-reporting.html">bug reporting
page</ulink>.</para>
<sect1><title>Convention</title>
<para>In this document, we adopt the following conventions for the Unix commands :</para>
<para>In this document, we adopt the following conventions for the Unix
commands :</para>
<itemizedlist>
<listitem><para>commands that should be typed as <emphasis>root</emphasis> have a <command>#</command> prompt :</para>
<listitem><para>commands that should be typed as
<emphasis>root</emphasis> have a <command>#</command> prompt :</para>
<screen>
<prompt># </prompt><userinput>command_to_be_typed_as_root</userinput>
</screen>
<listitem><para>commands that should be typed as a regular user have a <command>%</command> prompt :</para>
<listitem><para>commands that should be typed as a regular user have a
<command>%</command> prompt :</para>
<screen>
<prompt>% </prompt><userinput>command_to_be_typed_as_regular_user</userinput>
......
<chapter id="vlc"><title id="tvlc">The VideoLAN Client</title>
<chapter id="vlc"><title id="tvlc">The VideoLAN Client (VLC)</title>
<sect1><title>Installing the VideoLAN Client</title>
<sect1><title>Installing VLC</title>
&install-vlc;
</sect1>
<sect1><title>Running the VideoLAN Client</title>
<sect1><title>Running VLC</title>
<sect2><title>Read a File</title>
......
<chapter id="modules"><title id="tmodules">Modules and options for the VideoLAN Client</title>
<chapter id="modules"><title id="tmodules">Modules and options for VLC</title>
<sect1><title>The modules</title>
<para> The VideoLAN Client uses a modular system, which allows easy add
of new fonctions and supported formats. Here is a description of nearly
all the available modules for the VideoLAN Client. If you got the VLC
through a binary file, you will get the default modules. If, however,
you want to customize the VideoLAN Client to your needs, you will have
to compile the VLC from its sources.</para>
<para><emphasis>If you don't intend to compile the VLC and want only the "normal"
functions, reading this part is not very useful</emphasis></para>
<para>VLC uses a modular system, which allows to add easily new fonctions
and formats. Here is a description of nearly all the VLC
modules. If you installed VLC through a binary file, you will get
the default modules. If, however, you want to customize VLC to your
needs, you will have to compile the VLC from sources.</para>
<para><emphasis>If you don't intend to compile the VLC and
want only the regular functions, reading this part is not very
useful</emphasis>.</para>
<para> The compilation itself is explained in the next chapter.</para>
<para>If you wish to compile a module which is stated <emphasis>disabled
by default</emphasis>, you have to launch the configure script with
by default</emphasis>, you have to launch the configure script with :
</para>
<screen><prompt>% </prompt><userinput>
./configure --enable-module_name </userinput></screen>
<para>Of course, on the other hand, if you would like to disable a
module that is <emphasis>enabled by default</emphasis>, you would have to use the</para>
<screen><prompt>% </prompt><userinput>
./configure --disable-module_name </userinput></screen>
<para>switch when running the configuration script.</para>
<screen>
<prompt>% </prompt><userinput>./configure --enable-module_name </userinput>
</screen>
<para>On the other hand, if you would like to disable a module that is
<emphasis>enabled by default</emphasis>, you would have to use :</para>
<screen>
<prompt>% </prompt><userinput>./configure --disable-module_name </userinput>
</screen>
</sect1>
<!-- Video Outputs -->
<sect1><title>Video outputs</title>
<para>Video outputs are the modules that enable the support of some
systems for outputing the decoded video stream to your screen.</para>
<para>Video outputs are the modules that enable the support of some
systems to display the video on your screen.</para>
<sect2><title>x11</title>
<para><emphasis>default : enabled</emphasis></para>
......@@ -41,8 +49,8 @@ module that is <emphasis>enabled by default</emphasis>, you would have to use th
<para><emphasis>default : enabled</emphasis></para>
<para><emphasis>For Linux only</emphasis></para>
<para>It requires an xvideo compliant graphic card (it is the case for
nearly all the modern card). It uses hardware acceleration for yuv
transformation and for rescaling.</para>
nearly all modern cards). It uses hardware acceleration for YUV
transformation and rescaling.</para>
</sect2>
<sect2><title>sdl</title>
......@@ -440,8 +448,8 @@ of the categories described before</para>
<sect2><title>sout</title>
<para><emphasis>default: enabled</emphasis></para>
<para>Stream Output is a new feature of the VideoLAN Client that allows
him to stream, juste like the VideoLAN server</para>
<para>Stream Output is a new feature of VLC that allows
it to stream, juste like the VideoLAN server (VLS)</para>
<para>For more details, please have a look at the "Graphical user
interface" or "Command Line" sections.</para>
</sect2>
......@@ -493,11 +501,6 @@ definitely not recommended, as you would get a very poor VLC, and should
only be used for testing purposes</para>
</sect2>
</sect1>
</chapter>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment