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

Preparing the VLC user guide...

parent e267f45c
......@@ -77,17 +77,17 @@
<tr>
<td class="category"><b>VLC HOWTO</b></td>
<td class="category"><b>VLC user guide</b></td>
<td>Complete guide of VLC</td>
<td class="no">Out-of-date</td>
<td class="yes"><a href="/doc/vlc-old/doc/vlc-howto.html">Yes</a></td>
<td class="no">No</td>
<td class="yes"><a href="/doc/vlc-old/doc/vlc-howto.pdf">Yes</a></td>
<td class="no">No</td>
<td class="no">No</td>
<td class="no">No</td>
<td class="no">No</td>
<td class="no">No</td>
<td class="yes">Up-of-date</td>
<td class="yes"><a href="/doc/vlc-user-guide/">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide-html.zip">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide.pdf">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide-pdf.zip">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide.ps">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide-ps.zip">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide-rtf.zip">Yes</a></td>
<td class="yes"><a href="/doc/vlc-user-guide/vlc-user-guide.txt">Yes</a></td>
</tr>
......@@ -96,7 +96,7 @@
<td class="category"><b>VLC FAQ</b></td>
<td>Frequently Asked Questions of VLC users</td>
<td class="yes">Up-to-date</td>
<td class="yes"><a href="/doc/faq-vlc/faq/book1.html">Yes</a></td>
<td class="yes"><a href="/doc/faq-vlc/faq/">Yes</a></td>
<td class="yes"><a href="/doc/faq-vlc/faq/FAQ-vlc-html.zip">Yes</a></td>
<td class="yes"><a href="/doc/faq-vlc/faq/FAQ-vlc.pdf">Yes</a></td>
<td class="yes"><a href="/doc/faq-vlc/faq/FAQ-vlc-pdf.zip">Yes</a></td>
......@@ -109,4 +109,4 @@
</table>
<? footer('$Id: index.html,v 1.22 2003/02/01 12:00:13 alexis Exp $'); ?>
<? footer('$Id: index.html,v 1.23 2003/02/02 02:28:25 alexis Exp $'); ?>
......@@ -31,4 +31,4 @@ txt:
sgmltools -b txt videolan-howto.sgml
clean:
rm -f *.zip *.html *.pdf *.ps
rm -f *.zip *.html *.pdf *.ps *.txt
......@@ -31,4 +31,4 @@ txt:
sgmltools -b txt videolan-quickstart.sgml
clean:
rm -f *.zip *.html *.pdf *.ps
rm -f *.zip *.html *.pdf *.ps *.txt
......@@ -8,36 +8,36 @@
<sect1><title>Opening streams</title>
<para>The following commands start vlc and add a first element to the playlist.</para>
<para>The following commands start VLC and add a first element to the playlist.</para>
<sect2><title>Opening a file</title>
<para>Simply start vlc with</para>
<screen><prompt>%</prompt><userinput>vlc my_file.mpg</userinput></screen>
<para>Simply start VLC with</para>
<screen><prompt>% </prompt><userinput>vlc my_file.mpg</userinput></screen>
<para>Although the VideoLAN Client should be able to recognize the file
type, you may tell Vlc what codec to use with the
type, you may tell VLC what codec to use with the
<emphasis>-codec</emphasis> option. For example to play
my_file.mpg using ffmpeg audo/video decoder do
</para>
<screen>
<prompt>%</prompt><userinput>vlc --codec ffmpeg my_file.mpg</userinput>
<prompt>% </prompt><userinput>vlc --codec ffmpeg my_file.mpg</userinput>
</screen>
<para> A list of all video and audio codecs supported by
vlc is available <ulink
VLC is available <ulink
url="http://www.videolan.org/vlc/feature.html">here</ulink></para>
</sect2>
<sect2><title>Opening a DVD or VCD</title>
<para>Simply start vlc with</para>
<para>Simply start VLC with</para>
<screen><prompt>%</prompt><userinput>vlc dvd:[device][@raw_device][@[title][,[chapter][,angle]]]</userinput></screen>
<screen><prompt>% </prompt><userinput>vlc dvd:[device][@raw_device][@[title][,[chapter][,angle]]]</userinput></screen>
<para>or</para>
<screen><prompt>%</prompt><userinput>vlc vcd:[device][@[title][,[chapter]</userinput></screen>
<screen><prompt>% </prompt><userinput>vlc vcd:[device][@[title][,[chapter]</userinput></screen>
<para>where device is the complete path to your dvd/cdrom drive.
</para>
......@@ -46,7 +46,7 @@ url="http://www.videolan.org/vlc/feature.html">here</ulink></para>
<para>To receive an UDP stream (being sent by a VideoLAN Server), start the VideoLAN Client with</para>
<screen><prompt>%</prompt><userinput>vlc udpstream:[@bind address[:server_port]]</userinput></screen>
<screen><prompt>% </prompt><userinput>vlc udpstream:[@bind address[:server_port]]</userinput></screen>
<para>
Please note that bind address refers to the destination address, for
......@@ -55,10 +55,10 @@ example your broadcast address. If the stream is being broadcasted
</para>
<para>
To receive a http stream (VOD), start vlc with vlc your_url :
To receive a http stream (VOD), start VLC with :
</para>
<screen><prompt>%</prompt><userinput>vlc http://your.url.to/your_file.mpg</userinput></screen>
<screen><prompt>% </prompt><userinput>vlc http://www.example.org/your_file.mpg</userinput></screen>
</sect2>
</sect1>
......@@ -66,7 +66,7 @@ To receive a http stream (VOD), start vlc with vlc your_url :
<sect1><title>Modules selection</title>
<para>
The Vlc tries to select the most appropriate interface, input and output
VLC tries to select the most appropriate interface, input and output
modules, among the ones available on the system, according to the stream
he is given to read. However, you may wish to force the use of a
specific module with the following options: (Available modules are
......@@ -94,10 +94,9 @@ allows you to force the demux module.</para>
<sect1><title>Stream Output</title>
<para>Stream output is a new feature of the VideoLAN Client, which allow
you to stream <emphasis>from</emphasis> a VLC, allowing you to save the
Video that you are watching to a file, or to udp-stream
it over a LAN.</para>
<para>Stream output is a new feature of VLC, which allows you to save
the video that you are watching to a file, or to stream it in UDP over
an IP network.</para>
<itemizedlist>
<listitem><para><emphasis>--sout &lt;string&gt;</emphasis> enables stream output to <emphasis>string</emphasis> (<emphasis>string</emphasis> can be either a file name or a ip adress).</para>
......@@ -105,7 +104,7 @@ it over a LAN.</para>
<listitem><para><emphasis>--no-sout-video</emphasis> disables video stream output</para>
<listitem><para><emphasis>--sout-acodec [|mpeg1|mpeg2|mpeg4|vorbis]</emphasis> allows you to force audio encoding.</para>
<listitem><para><emphasis>--sout-vcodec [|mpeg1|mpeg2|mpeg4]</emphasis> allows you to force video encoding.</para>
<listitem><para><emphasis>--packetizer &lt;string&gt;</emphasis> allows you to select the order in which vlc will select its packetizers.</para>
<listitem><para><emphasis>--packetizer &lt;string&gt;</emphasis> allows you to select the order in which VLC will select its packetizers.</para>
<listitem><para><emphasis>--mux &lt;string&gt;</emphasis> lets you configure mux modules.</para>
<listitem><para><emphasis>--access_output &lt;string&gt;</emphasis> lets you configure access output modules.</para>
</itemizedlist>
......@@ -119,7 +118,7 @@ it over a LAN.</para>
<itemizedlist>
<listitem><para><emphasis>--noaudio</emphasis> disables audio
output</para>
<listitem><para><emphasis>--mono</emphasis> forces the vlc to treat the
<listitem><para><emphasis>--mono</emphasis> forces the VLC to treat the
stream in mono audio.</para>
<listitem><para><emphasis>--volume &lt;integer&gt;</emphasis> sets the
level of audio output.</para>
......@@ -241,7 +240,7 @@ options.</para>
<listitem><para><emphasis>--longhelp</emphasis> gives you a detailled
version of the available options.</para>
<listitem><para><emphasis>--version</emphasis> gives you information
about the current vlc version.</para>
about the current VLC version.</para>
<listitem><para><emphasis>--list</emphasis> displays a list of available
plugins</para>
<listitem><para><emphasis>--module &lt;module&gt;</emphasis> displays
......
......@@ -185,7 +185,7 @@ processors).</para>
<sect2><title>Playlist tab</title>
<para>In this tab, you can select some playlist options, such as looping
the playlist, automatically launching the playlist on vlc start, enqueue
the playlist, automatically launching the playlist on VLC's start, enqueue
items in it or randomly read the files.</para>
</sect2>
......
......@@ -13,11 +13,11 @@ functions, reading this part is not very useful</emphasis></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
</para>
<screen><prompt>%</prompt><userinput>
<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>
<screen><prompt>% </prompt><userinput>
./configure --disable-module_name </userinput></screen>
<para>switch when running the configuration script.</para>
</sect1>
......@@ -237,7 +237,7 @@ sources</para>
<!-- Demuxers -->
<sect1><title>Demuxers</title>
<para>Demuxers or demultiplexers allow the VLC to extract the stream(s)
<para>Demuxers or demultiplexers allow VLC to extract the stream(s)
from the file or source where they are into.</para>
<para>For example, an AVI file can contain a MPEG-4 video, or an
uncompressed video. AVI is only a storing format, not a compression
......@@ -313,7 +313,7 @@ This is the QT libraries interface module. You will need the libraries (libqt2 p
</sect2><sect2><title>rc</title>
<para><emphasis>default: enabled</emphasis></para>
<para>This is the Remote Control interface module. With this one, vlc is controled by sending him commands, such as play, stop, ... so that you may control vlc through a script.</para>
<para>This is the Remote Control interface module. With this one, VLC is controled by sending him commands, such as play, stop, ... so that you may control VLC through a script.</para>
</sect2><sect2><title>ncurses</title>
<para><emphasis>default: disabled</emphasis></para>
......@@ -322,7 +322,7 @@ This is the QT libraries interface module. You will need the libraries (libqt2 p
</sect2><sect2><title>lirc</title>
<para><emphasis>default: disabled</emphasis></para>
<para>
This interface module allows you to control vlc through a remote. A lircrc example is provided to help you configure it to your remote (see doc/lirc/example.lircrc).</para>
This interface module allows you to control VLC through a remote. A lircrc example is provided to help you configure it to your remote (see doc/lirc/example.lircrc).</para>
</sect2>
<sect2><title>wxwindows</title>
......@@ -448,13 +448,13 @@ interface" or "Command Line" sections.</para>
<sect2><title>test-suite</title>
<para><emphasis>default: disabled</emphasis></para>
<para>This builds a special vlc, for testing purposes only</para>
<para>This builds a special VLC, for testing purposes only</para>
</sect2>
<sect2><title>mozilla</title>
<para><emphasis>default: disabled</emphasis></para>
<para>This is not really a module. When enabled, a vlc-based Mozilla
<para>This is not really a module. When enabled, a VLC-based Mozilla
plugin is built</para>
</sect2>
......@@ -481,8 +481,8 @@ Display)</para>
<prompt>% </prompt><userinput>./configure --help</userinput>
</screen>
<para>You can for example control all the installation directories, the
system for which you want to build the VLC for (if not guessed
<para>You can for example control all the installation directories,
the system for which you want to build VLC for (if not guessed
correctly),...</para>
<para>You can also choose to enable or disable some optimizations</para>
......
......@@ -19,16 +19,20 @@
<bookinfo>
<title>VideoLAN Client User Guide</title>
<title>VLC User Guide</title>
<authorgroup>
<author>
<firstname>Henri</firstname>
<surname>Fallon</surname>
</author>
<author>
<firstname>Alexis</firstname>
<surname>de Lattre</surname>
</author>
<author>
<firstname>Bill</firstname>
<surname>Eldridge</surname>
<firstname>Johan</firstname>
<surname>Bilien</surname>
</author>
<author>
<firstname>Anil</firstname>
......@@ -79,7 +83,7 @@ Texts. The text of the license can be found in the appendix
<abstract>
<para>This document describes how use the VideoLAN Client.</para>
<para>This document is the complete user guide of VLC, the VideoLAN Client.</para>
</abstract>
......
......@@ -92,11 +92,13 @@ screenshots</a>. </p>
</tr>
<tr>
<td class="category">VLC HOWTO</td>
<td class="no">Out-of-date</td>
<td class="category">VLC user guide</td>
<td class="yes">Up-to-date</td>
<td>
<a href="/doc/vlc-old/doc/vlc-howto.html">HTML</a>
<a href="/doc/vlc-old/doc/vlc-howto.pdf">PDF</a>
<a href="/doc/vlc-user-guide/">HTML</a>
<a href="/doc/vlc-user-guide/vlc-user-guide.pdf">PDF</a>
<a href="/doc/vlc-user-guide/vlc-user-guide.ps">PS</a>
<a href="/doc/vlc-user-guide/vlc-user-guide.txt">TXT</a>
</td>
</tr>
......@@ -104,7 +106,7 @@ screenshots</a>. </p>
<td class="category">VLC FAQ</td>
<td class="yes">Up-to-date</td>
<td>
<a href="/doc/faq-vlc/faq/book1.html">HTML</a>
<a href="/doc/faq-vlc/faq/">HTML</a>
<a href="/doc/faq-vlc/faq/FAQ-vlc.pdf">PDF</a>
<a href="/doc/faq-vlc/faq/FAQ-vlc.ps">PS</a>
<a href="/doc/faq-vlc/faq/FAQ-vlc.txt">TXT</a>
......@@ -122,4 +124,4 @@ screenshots</a>. </p>
</tr>
</table>
<? footer('$Id: index.html,v 1.43 2003/02/01 12:05:51 alexis Exp $'); ?>
<? footer('$Id: index.html,v 1.44 2003/02/02 02:28:26 alexis Exp $'); ?>
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