mirror of https://github.com/tLDP/LDP
new
This commit is contained in:
parent
d66ec8501e
commit
e2090db4b9
|
@ -0,0 +1,103 @@
|
|||
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook V4.1//EN'
|
||||
[
|
||||
<!ENTITY % magic-entities SYSTEM "magic.sgml">
|
||||
%magic-entities;
|
||||
|
||||
<!ENTITY intro SYSTEM "intro.sgml">
|
||||
<!ENTITY modules SYSTEM "modules.sgml">
|
||||
<!ENTITY install SYSTEM "install.sgml">
|
||||
<!ENTITY gui SYSTEM "gui.sgml">
|
||||
<!ENTITY cmdline SYSTEM "cmdline.sgml">
|
||||
|
||||
<!ENTITY install-vlc SYSTEM "install-vlc.sgml">
|
||||
<!ENTITY uninstall-vlc SYSTEM "uninstall-vlc.sgml">
|
||||
<!ENTITY fdl SYSTEM "fdl.sgml">
|
||||
|
||||
]>
|
||||
|
||||
<book>
|
||||
|
||||
<bookinfo>
|
||||
|
||||
<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>Johan</firstname>
|
||||
<surname>Bilien</surname>
|
||||
</author>
|
||||
<author>
|
||||
<firstname>Anil</firstname>
|
||||
<surname>Daoud</surname>
|
||||
</author>
|
||||
<author>
|
||||
<firstname>Mathieu</firstname>
|
||||
<surname>Gautier</surname>
|
||||
</author>
|
||||
<author>
|
||||
<firstname>Clément</firstname>
|
||||
<surname>Stenac</surname>
|
||||
</author>
|
||||
</authorgroup>
|
||||
|
||||
<copyright>
|
||||
<year>2002, 2003</year>
|
||||
<holder>the VideoLAN project</holder>
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.2 or
|
||||
any later version published by the Free Software Foundation ; with no
|
||||
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
|
||||
Texts. The text of the license can be found in the appendix
|
||||
<xref linkend="gfdl" endterm="tgfdl">.</para>
|
||||
|
||||
</legalnotice>
|
||||
|
||||
<keywordset>
|
||||
<keyword>VideoLAN</keyword>
|
||||
<keyword>Client</keyword>
|
||||
<keyword>vlc</keyword>
|
||||
<keyword>vls</keyword>
|
||||
<keyword>vod</keyword>
|
||||
<keyword>vlcs</keyword>
|
||||
<keyword>stream</keyword>
|
||||
<keyword>multicast</keyword>
|
||||
<keyword>MPEG 1</keyword>
|
||||
<keyword>MPEG 2</keyword>
|
||||
<keyword>MPEG 4</keyword>
|
||||
<keyword>DVD</keyword>
|
||||
<keyword>DivX</keyword>
|
||||
</keywordset>
|
||||
|
||||
<abstract>
|
||||
|
||||
<para>This document is the complete user guide of VLC, the VideoLAN Client.</para>
|
||||
|
||||
</abstract>
|
||||
|
||||
|
||||
</bookinfo>
|
||||
|
||||
|
||||
<toc></toc>
|
||||
|
||||
&intro;
|
||||
&modules;
|
||||
&install;
|
||||
&gui;
|
||||
&cmdline;
|
||||
&fdl;
|
||||
|
||||
</book>
|
|
@ -0,0 +1,336 @@
|
|||
<chapter id="cmdline"><title id="tcmdline">The Command Line Interface</title>
|
||||
|
||||
<sect1><title>Introduction</title>
|
||||
|
||||
<para>Many options are only available through command line. They are
|
||||
detailed here.</para>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Opening streams</title>
|
||||
|
||||
<para>The following commands start VLC and add the first element to the
|
||||
playlist.</para>
|
||||
|
||||
<sect2><title>Opening a file</title>
|
||||
|
||||
<para>Start VLC with :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>vlc my_file.mpg</userinput>
|
||||
</screen>
|
||||
|
||||
<para>Although VLC should be able to recognize the file
|
||||
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>
|
||||
</screen>
|
||||
|
||||
<para>A list of all video and audio codecs supported by VLC is available
|
||||
on the <ulink url="http://www.videolan.org/vlc/features.html">VLC
|
||||
features list</ulink></para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Opening a DVD or VCD</title>
|
||||
|
||||
<para>Start VLC with :<para>
|
||||
|
||||
<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>
|
||||
|
||||
<para>where device is the complete path to your DVD or CD-ROM drive.</para>
|
||||
|
||||
<sect2><title>Start a network stream</title>
|
||||
|
||||
<para>To receive an unicast UDP stream (sent by VLS or VLC's stream
|
||||
output), start VLC with :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>vlc udp:[@:server_port]</userinput>
|
||||
</screen>
|
||||
|
||||
<para>To receive a multicast UDP stream (sent by VLS or VLC's
|
||||
stream output), start VLC with :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>vlc udp:@multicast_address[:server_port]</userinput>
|
||||
</screen>
|
||||
|
||||
<para>To receive a HTTP stream, start VLC with :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>vlc http://www.example.org/your_file.mpg</userinput>
|
||||
</screen>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Modules selection</title>
|
||||
|
||||
<para>VLC tries to select the most appropriate interface, input and
|
||||
output modules, among the ones available on the system, according to the
|
||||
stream it is given to read. However, you may wish to force the use of a
|
||||
specific module with the following options (for the complete list of
|
||||
modules, see the <xref linkend="modules" endterm="tmodules"> section) :
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>--intf <module></emphasis>
|
||||
allows you to select the interface module.</para>
|
||||
<listitem><para><emphasis>--aout <module></emphasis>
|
||||
allows you to select the audio output module.</para>
|
||||
<listitem><para><emphasis>--vout <module></emphasis>
|
||||
allows you to select the video output module.</para>
|
||||
<listitem><para><emphasis>--filter <module></emphasis>
|
||||
allows you to add a video filter module.</para>
|
||||
<listitem><para><emphasis>--memcpy <module></emphasis>
|
||||
allows you to choose a memory copy module.</para>
|
||||
<listitem><para><emphasis>--access <module></emphasis>
|
||||
allows you to force the access module.</para>
|
||||
<listitem><para><emphasis>--demux <module></emphasis>
|
||||
allows you to force the demux module.</para>
|
||||
</itemizedlist>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Stream Output</title>
|
||||
|
||||
<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.</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--sout <string></emphasis>
|
||||
enables stream output to <emphasis>string</emphasis>
|
||||
(<emphasis>string</emphasis> can be either a file name or a ip
|
||||
adress).</para>
|
||||
|
||||
<listitem><para><emphasis>--no-sout-audio</emphasis> disables audio
|
||||
stream output.</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 <string></emphasis> allows
|
||||
you to select the order in which VLC will select its packetizers.</para>
|
||||
|
||||
<listitem><para><emphasis>--mux <string></emphasis> lets you
|
||||
configure mux modules.</para>
|
||||
|
||||
<listitem><para><emphasis>--access_output <string></emphasis> lets
|
||||
you configure access output modules.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Other Options</title>
|
||||
|
||||
<sect2><title>Audio options</title>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>--noaudio</emphasis> disables audio
|
||||
output.</para>
|
||||
<listitem><para><emphasis>--mono</emphasis> forces VLC to treat the
|
||||
stream in mono audio.</para>
|
||||
<listitem><para><emphasis>--volume <integer></emphasis> sets the
|
||||
level of audio output.</para>
|
||||
<listitem><para><emphasis>--aout-rate <integer></emphasis> sets
|
||||
the audio output frequency (Hz).</para>
|
||||
<listitem><para><emphasis>--desync <integer></emphasis>
|
||||
compensates desynchronization of audio (ms).</para>
|
||||
<listitem><para><emphasis>--headphone</emphasis> activates headphone
|
||||
virtual spatialization effect.</para>
|
||||
<listitem><para><emphasis>--headphone-dim</emphasis> sets headphone
|
||||
characteristic dimension.</para>
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Video options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--novideo</emphasis> disables video
|
||||
output.</para>
|
||||
|
||||
<listitem><para><emphasis>--greyscale</emphasis> turns video output into
|
||||
greyscale mode.</para>
|
||||
|
||||
<listitem><para><emphasis>--fullscreen</emphasis> sets fullscreen
|
||||
video.</para>
|
||||
|
||||
<listitem><para><emphasis>--nooverlay</emphasis> disables hardware
|
||||
acceleration for the video output.</para>
|
||||
|
||||
<listitem><para><emphasis>--width, --height <integer></emphasis>
|
||||
sets the video window dimensions.</para>
|
||||
|
||||
<listitem><para><emphasis>--zoom <float></emphasis> adds a zoom
|
||||
factor.</para>
|
||||
|
||||
<listitem><para><emphasis>--aspect-ratio <mode></emphasis> forces
|
||||
source aspect ratio.</para>
|
||||
|
||||
<listitem><para><emphasis>--spumargin <integer></emphasis> forces
|
||||
SPU subtitles postion.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Playlist options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--playlist</emphasis> launches playlist on
|
||||
startup.</para>
|
||||
|
||||
<listitem><para><emphasis>--random</emphasis> plays files randomly
|
||||
forever.</para>
|
||||
|
||||
<listitem><para><emphasis>--enqueue</emphasis> enqueues items in
|
||||
playlist.</para>
|
||||
|
||||
<listitem><para><emphasis>--loop</emphasis> loops playlist on end.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Network options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--server-port <integer></emphasis> sets
|
||||
server port.</para>
|
||||
|
||||
<listitem><para><emphasis>--network-channel</emphasis> enables network
|
||||
channel mode.</para>
|
||||
|
||||
<listitem><para><emphasis>--channel-server <string></emphasis>
|
||||
specifies the channel server address.</para>
|
||||
|
||||
<listitem><para><emphasis>--channel-port <integer></emphasis>
|
||||
specifies the channel server port.</para>
|
||||
|
||||
<listitem><para><emphasis>--iface <string></emphasis> specifies
|
||||
the network interface to use.</para>
|
||||
|
||||
<listitem><para><emphasis>--iface-addr <string></emphasis>
|
||||
specifies your network interface IP address.</para>
|
||||
|
||||
<listitem><para><emphasis>--mtu <integer></emphasis> specifies
|
||||
the MTU of the network interface.</para>
|
||||
|
||||
<listitem><para><emphasis>--ipv6</emphasis> forces IPv6.</para>
|
||||
|
||||
<listitem><para><emphasis>--ipv4</emphasis> forces IPv4.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>CPU options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--nommx</emphasis> disables the use of MMX CPU
|
||||
extensions.</para>
|
||||
|
||||
<listitem><para><emphasis>--no3dn</emphasis> disables the use of 3D Now!
|
||||
CPU extensions.</para>
|
||||
|
||||
<listitem><para><emphasis>--nommxext</emphasis> disables the use of MMX
|
||||
ext CPU extensions.</para>
|
||||
|
||||
<listitem><para><emphasis>--nosse</emphasis> disables the use of SSE
|
||||
CPU extensions.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Miscellaneous options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--quiet</emphasis> be quiet.</para>
|
||||
|
||||
<listitem><para><emphasis>--color</emphasis> displays color messages.</para>
|
||||
|
||||
<listitem><para><emphasis>--search-path <string></emphasis>
|
||||
specifies interface default search path.</para>
|
||||
|
||||
<listitem><para><emphasis>--plugin-path <string></emphasis>
|
||||
specifies plugin search path.</para>
|
||||
|
||||
<listitem><para><emphasis>--dvd <string></emphasis>
|
||||
specifies the default dvd device.</para>
|
||||
|
||||
<listitem><para><emphasis>--vcd <string></emphasis>
|
||||
specifies the default vcd device.</para>
|
||||
|
||||
<listitem><para><emphasis>--program <integer></emphasis> specifies
|
||||
program (SID) (for streams with several programs, like satellite ones).</para>
|
||||
|
||||
<listitem><para><emphasis>--audio-type <integer></emphasis>
|
||||
specifies the default audio type to use with dvds.</para>
|
||||
|
||||
<listitem><para><emphasis>--audio-channel <integer></emphasis>
|
||||
specifies the default audio channel to use with dvds.</para>
|
||||
|
||||
<listitem><para><emphasis>--spu-channel <integer></emphasis>
|
||||
specifies the default subtitle channel to use with dvds.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Help options</title>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>--verbose <verbosity></emphasis>
|
||||
specifies verbosity level.</para>
|
||||
|
||||
<listitem><para><emphasis>--help</emphasis> gives you all available
|
||||
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>
|
||||
|
||||
<listitem><para><emphasis>--list</emphasis> displays a list of available
|
||||
plugins.</para>
|
||||
|
||||
<listitem><para><emphasis>--module <module></emphasis> displays
|
||||
help about specified module.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
</chapter>
|
|
@ -0,0 +1,431 @@
|
|||
<appendix id="gfdl">
|
||||
<title id="tgfdl">GNU Free Documentation License</title>
|
||||
<subtitle>Version 1.2, November 2002</subtitle>
|
||||
|
||||
<blockquote id="fsf-copyright">
|
||||
<para>Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.</para>
|
||||
</blockquote>
|
||||
|
||||
<sect1 id="gfdl-0"><title>PREAMBLE</title>
|
||||
|
||||
<para>The purpose of this License is to make a manual, textbook, or
|
||||
other functional and useful document "free" in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it, with
|
||||
or without modifying it, either commercially or noncommercially.
|
||||
Secondarily, this License preserves for the author and publisher a way
|
||||
to get credit for their work, while not being considered responsible for
|
||||
modifications made by others.</para>
|
||||
|
||||
<para>This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft license
|
||||
designed for free software.</para>
|
||||
|
||||
<para>We have designed this License in order to use it for manuals for
|
||||
free software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals; it
|
||||
can be used for any textual work, regardless of subject matter or
|
||||
whether it is published as a printed book. We recommend this License
|
||||
principally for works whose purpose is instruction or reference.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-1"><title>APPLICABILITY AND DEFINITIONS</title>
|
||||
|
||||
<para id="gfdl-doc">This License applies to any manual or other work, in
|
||||
any medium, that contains a notice placed by the copyright holder saying
|
||||
it can be distributed under the terms of this License. Such a notice
|
||||
grants a world-wide, royalty-free license, unlimited in duration, to use
|
||||
that work under the conditions stated herein. The "Document", below,
|
||||
refers to any such manual or work. Any member of the public is a
|
||||
licensee, and is addressed as "you". You accept the license if you
|
||||
copy, modify or distribute the work in a way requiring permission under
|
||||
copyright law.</para>
|
||||
|
||||
<para id="gfdl-mod-ver">A "Modified Version" of the Document means any
|
||||
work containing the Document or a portion of it, either copied verbatim,
|
||||
or with modifications and/or translated into another language.</para>
|
||||
|
||||
<para id="gfdl-secnd-sect">A "Secondary Section" is a named appendix or
|
||||
a front-matter section of the Document that deals exclusively with the
|
||||
relationship of the publishers or authors of the Document to the
|
||||
Document's overall subject (or to related matters) and contains nothing
|
||||
that could fall directly within that overall subject. (Thus, if the
|
||||
Document is in part a textbook of mathematics, a Secondary Section may
|
||||
not explain any mathematics.) The relationship could be a matter of
|
||||
historical connection with the subject or with related matters, or of
|
||||
legal, commercial, philosophical, ethical or political position
|
||||
regarding them.</para>
|
||||
|
||||
<para id="gfdl-inv-sect">The "Invariant Sections" are certain Secondary
|
||||
Sections whose titles are designated, as being those of Invariant
|
||||
Sections, in the notice that says that the Document is released under
|
||||
this License. If a section does not fit the above definition of
|
||||
Secondary then it is not allowed to be designated as Invariant. The
|
||||
Document may contain zero Invariant Sections. If the Document does not
|
||||
identify any Invariant Sections then there are none.</para>
|
||||
|
||||
<para id="gfdl-cov-text">The "Cover Texts" are certain short passages of
|
||||
text that are listed, as Front-Cover Texts or Back-Cover Texts, in the
|
||||
notice that says that the Document is released under this License. A
|
||||
Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at
|
||||
most 25 words.</para>
|
||||
|
||||
<para id="gfdl-transparent">A "Transparent" copy of the Document means a
|
||||
machine-readable copy, represented in a format whose specification is
|
||||
available to the general public, that is suitable for revising the
|
||||
document straightforwardly with generic text editors or (for images
|
||||
composed of pixels) generic paint programs or (for drawings) some widely
|
||||
available drawing editor, and that is suitable for input to text
|
||||
formatters or for automatic translation to a variety of formats suitable
|
||||
for input to text formatters. A copy made in an otherwise Transparent
|
||||
file format whose markup, or absence of markup, has been arranged to
|
||||
thwart or discourage subsequent modification by readers is not
|
||||
Transparent. An image format is not Transparent if used for any
|
||||
substantial amount of text. A copy that is not "Transparent" is called
|
||||
"Opaque".</para>
|
||||
|
||||
<para>Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML or
|
||||
XML using a publicly available DTD, and standard-conforming simple HTML,
|
||||
PostScript or PDF designed for human modification. Examples of
|
||||
transparent image formats include PNG, XCF and JPG. Opaque formats
|
||||
include proprietary formats that can be read and edited only by
|
||||
proprietary word processors, SGML or XML for which the DTD and/or
|
||||
processing tools are not generally available, and the machine-generated
|
||||
HTML, PostScript or PDF produced by some word processors for output
|
||||
purposes only.</para>
|
||||
|
||||
<para id="gfdl-title-page">The "Title Page" means, for a printed book,
|
||||
the title page itself, plus such following pages as are needed to hold,
|
||||
legibly, the material this License requires to appear in the title page.
|
||||
For works in formats which do not have any title page as such, "Title
|
||||
Page" means the text near the most prominent appearance of the work's
|
||||
title, preceding the beginning of the body of the text.</para>
|
||||
|
||||
<para id="gfdl-entitled">A section "Entitled XYZ" means a named subunit
|
||||
of the Document whose title either is precisely XYZ or contains XYZ in
|
||||
parentheses following text that translates XYZ in another language.
|
||||
(Here XYZ stands for a specific section name mentioned below, such as
|
||||
"Acknowledgements", "Dedications", "Endorsements", or "History".) To
|
||||
"Preserve the Title" of such a section when you modify the Document
|
||||
means that it remains a section "Entitled XYZ" according to this
|
||||
definition.</para>
|
||||
|
||||
<para>The Document may include Warranty Disclaimers next to the notice
|
||||
which states that this License applies to the Document. These Warranty
|
||||
Disclaimers are considered to be included by reference in this License,
|
||||
but only as regards disclaiming warranties: any other implication that
|
||||
these Warranty Disclaimers may have is void and has no effect on the
|
||||
meaning of this License.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-2"><title>VERBATIM COPYING</title>
|
||||
|
||||
<para>You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies to
|
||||
the Document are reproduced in all copies, and that you add no other
|
||||
conditions whatsoever to those of this License. You may not use
|
||||
technical measures to obstruct or control the reading or further copying
|
||||
of the copies you make or distribute. However, you may accept
|
||||
compensation in exchange for copies. If you distribute a large enough
|
||||
number of copies you must also follow the conditions in section 3.
|
||||
</para>
|
||||
|
||||
<para>You may also lend copies, under the same conditions stated above,
|
||||
and you may publicly display copies.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-3"><title>COPYING IN QUANTITY</title>
|
||||
|
||||
<para>If you publish printed copies (or copies in media that commonly
|
||||
have printed covers) of the Document, numbering more than 100, and the
|
||||
Document's license notice requires Cover Texts, you must enclose the
|
||||
copies in covers that carry, clearly and legibly, all these Cover Texts:
|
||||
Front-Cover Texts on the front cover, and Back-Cover Texts on the back
|
||||
cover. Both covers must also clearly and legibly identify you as the
|
||||
publisher of these copies. The front cover must present the full title
|
||||
with all words of the title equally prominent and visible. You may add
|
||||
other material on the covers in addition. Copying with changes limited
|
||||
to the covers, as long as they preserve the title of the Document and
|
||||
satisfy these conditions, can be treated as verbatim copying in other
|
||||
respects.</para>
|
||||
|
||||
<para>If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||
pages.</para>
|
||||
|
||||
<para>If you publish or distribute Opaque copies of the Document
|
||||
numbering more than 100, you must either include a machine-readable
|
||||
Transparent copy along with each Opaque copy, or state in or with each
|
||||
Opaque copy a computer-network location from which the general
|
||||
network-using public has access to download using public-standard
|
||||
network protocols a complete Transparent copy of the Document, free of
|
||||
added material. If you use the latter option, you must take reasonably
|
||||
prudent steps, when you begin distribution of Opaque copies in quantity,
|
||||
to ensure that this Transparent copy will remain thus accessible at the
|
||||
stated location until at least one year after the last time you
|
||||
distribute an Opaque copy (directly or through your agents or retailers)
|
||||
of that edition to the public.</para>
|
||||
|
||||
<para>It is requested, but not required, that you contact the authors of
|
||||
the Document well before redistributing any large number of copies, to
|
||||
give them a chance to provide you with an updated version of the
|
||||
Document.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-4"><title>MODIFICATIONS</title>
|
||||
|
||||
<para>You may copy and distribute a Modified Version of the Document
|
||||
under the conditions of sections 2 and 3 above, provided that you
|
||||
release the Modified Version under precisely this License, with the
|
||||
Modified Version filling the role of the Document, thus licensing
|
||||
distribution and modification of the Modified Version to whoever
|
||||
possesses a copy of it. In addition, you must do these things in the
|
||||
Modified Version:</para>
|
||||
|
||||
<orderedlist id="gfdl-modif-cond" numeration="upperalpha">
|
||||
<listitem><simpara>Use in the Title Page (and on the covers, if any) a
|
||||
title distinct from that of the Document, and from those of previous
|
||||
versions (which should, if there were any, be listed in the History
|
||||
section of the Document). You may use the same title as a previous
|
||||
version if the original publisher of that version gives permission.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>List on the Title Page, as authors, one or more
|
||||
persons or entities responsible for authorship of the modifications in
|
||||
the Modified Version, together with at least five of the principal
|
||||
authors of the Document (all of its principal authors, if it has fewer
|
||||
than five), unless they release you from this requirement.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>State on the Title page the name of the publisher of
|
||||
the Modified Version, as the publisher.</simpara></listitem>
|
||||
<listitem><simpara>Preserve all the copyright notices of the Document.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Add an appropriate copyright notice for your
|
||||
modifications adjacent to the other copyright notices.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Include, immediately after the copyright notices, a
|
||||
license notice giving the public permission to use the Modified
|
||||
Version under the terms of this License, in the form shown in the
|
||||
<link linkend="gfdl-addendum">Addendum</link> below.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Preserve in that license notice the full lists of
|
||||
Invariant Sections and required Cover Texts given in the Document's
|
||||
license notice.</simpara></listitem>
|
||||
<listitem><simpara>Include an unaltered copy of this License.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Preserve the section Entitled "History", Preserve its
|
||||
Title, and add to it an item stating at least the title, year, new
|
||||
authors, and publisher of the Modified Version as given on the Title
|
||||
Page. If there is no section Entitled "History" in the Document,
|
||||
create one stating the title, year, authors, and publisher of the
|
||||
Document as given on its Title Page, then add an item describing the
|
||||
Modified Version as stated in the previous sentence.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Preserve the network location, if any, given in the
|
||||
Document for public access to a Transparent copy of the Document, and
|
||||
likewise the network locations given in the Document for previous
|
||||
versions it was based on. These may be placed in the "History"
|
||||
section. You may omit a network location for a work that was
|
||||
published at least four years before the Document itself, or if the
|
||||
original publisher of the version it refers to gives permission.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>For any section Entitled "Acknowledgements" or
|
||||
"Dedications", Preserve the Title of the section, and preserve in the
|
||||
section all the substance and tone of each of the contributor
|
||||
acknowledgements and/or dedications given therein.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Preserve all the Invariant Sections of the Document,
|
||||
unaltered in their text and in their titles. Section numbers or the
|
||||
equivalent are not considered part of the section titles.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Delete any section Entitled "Endorsements".
|
||||
Such a section may not be included in the Modified Version.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Do not retitle any existing section to be Entitled
|
||||
"Endorsements" or to conflict in title with any Invariant Section.
|
||||
</simpara></listitem>
|
||||
<listitem><simpara>Preserve any Warranty Disclaimers.
|
||||
</simpara></listitem>
|
||||
</orderedlist>
|
||||
|
||||
<para>If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all
|
||||
of these sections as invariant. To do this, add their titles to the
|
||||
list of Invariant Sections in the Modified Version's license notice.
|
||||
These titles must be distinct from any other section titles.</para>
|
||||
|
||||
<para>You may add a section Entitled "Endorsements", provided it
|
||||
contains nothing but endorsements of your Modified Version by various
|
||||
parties--for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.</para>
|
||||
|
||||
<para>You may add a passage of up to five words as a Front-Cover Text,
|
||||
and a passage of up to 25 words as a Back-Cover Text, to the end of the
|
||||
list of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or through
|
||||
arrangements made by) any one entity. If the Document already includes
|
||||
a cover text for the same cover, previously added by you or by
|
||||
arrangement made by the same entity you are acting on behalf of, you may
|
||||
not add another; but you may replace the old one, on explicit permission
|
||||
from the previous publisher that added the old one.</para>
|
||||
|
||||
<para>The author(s) and publisher(s) of the Document do not by this
|
||||
License give permission to use their names for publicity for or to
|
||||
assert or imply endorsement of any Modified Version.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-5"><title>COMBINING DOCUMENTS</title>
|
||||
|
||||
<para>You may combine the Document with other documents released under
|
||||
this License, under the terms defined in <link linkend="gfdl-4">section
|
||||
4</link> above for modified versions, provided that you include in the
|
||||
combination all of the Invariant Sections of all of the original
|
||||
documents, unmodified, and list them all as Invariant Sections of your
|
||||
combined work in its license notice, and that you preserve all their
|
||||
Warranty Disclaimers.</para>
|
||||
|
||||
<para>The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name but
|
||||
different contents, make the title of each such section unique by adding
|
||||
at the end of it, in parentheses, the name of the original author or
|
||||
publisher of that section if known, or else a unique number. Make the
|
||||
same adjustment to the section titles in the list of Invariant Sections
|
||||
in the license notice of the combined work.</para>
|
||||
|
||||
<para>In the combination, you must combine any sections Entitled
|
||||
"History" in the various original documents, forming one section
|
||||
Entitled "History"; likewise combine any sections Entitled
|
||||
"Acknowledgements", and any sections Entitled "Dedications". You must
|
||||
delete all sections Entitled "Endorsements".</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-6"><title>COLLECTIONS OF DOCUMENTS</title>
|
||||
|
||||
<para>You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual copies
|
||||
of this License in the various documents with a single copy that is
|
||||
included in the collection, provided that you follow the rules of this
|
||||
License for verbatim copying of each of the documents in all other
|
||||
respects.</para>
|
||||
|
||||
<para>You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert a
|
||||
copy of this License into the extracted document, and follow this
|
||||
License in all other respects regarding verbatim copying of that
|
||||
document.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-7"><title>AGGREGATION WITH INDEPENDENT WORKS</title>
|
||||
|
||||
<para>A compilation of the Document or its derivatives with other
|
||||
separate and independent documents or works, in or on a volume of a
|
||||
storage or distribution medium, is called an "aggregate" if the
|
||||
copyright resulting from the compilation is not used to limit the legal
|
||||
rights of the compilation's users beyond what the individual works
|
||||
permit. When the Document is included an aggregate, this License does
|
||||
not apply to the other works in the aggregate which are not themselves
|
||||
derivative works of the Document.</para>
|
||||
|
||||
<para>If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on covers
|
||||
that bracket the Document within the aggregate, or the electronic
|
||||
equivalent of covers if the Document is in electronic form. Otherwise
|
||||
they must appear on printed covers that bracket the whole
|
||||
aggregate.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-8"><title>TRANSLATION</title>
|
||||
|
||||
<para>Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warrany Disclaimers, provided that you also include
|
||||
the original English version of this License and the original versions
|
||||
of those notices and disclaimers. In case of a disagreement between the
|
||||
translation and the original version of this License or a notice or
|
||||
disclaimer, the original version will prevail.</para>
|
||||
|
||||
<para>If a section in the Document is Entitled "Acknowledgements",
|
||||
"Dedications", or "History", the requirement (section 4) to Preserve its
|
||||
Title (section 1) will typically require changing the actual
|
||||
title.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-9"><title>TERMINATION</title>
|
||||
|
||||
<para>You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided for under this License. Any other attempt
|
||||
to copy, modify, sublicense or distribute the Document is void, and will
|
||||
automatically terminate your rights under this License. However,
|
||||
parties who have received copies, or rights, from you under this License
|
||||
will not have their licenses terminated so long as such parties remain
|
||||
in full compliance.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-10"><title>FUTURE REVISIONS OF THIS LICENSE</title>
|
||||
|
||||
<para>The Free Software Foundation may publish new, revised versions of
|
||||
the GNU Free Documentation License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns. See
|
||||
http://www.gnu.org/copyleft/.</para>
|
||||
|
||||
<para>Each version of the License is given a distinguishing version
|
||||
number. If the Document specifies that a particular numbered version of
|
||||
this License "or any later version" applies to it, you have the option
|
||||
of following the terms and conditions either of that specified version
|
||||
or of any later version that has been published (not as a draft) by the
|
||||
Free Software Foundation. If the Document does not specify a version
|
||||
number of this License, you may choose any version ever published (not
|
||||
as a draft) by the Free Software Foundation.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-addendum"><title>ADDENDUM: How to use this License for
|
||||
your documents</title>
|
||||
|
||||
<para>To use this License in a document you have written, include a copy
|
||||
of the License in the document and put the following copyright and
|
||||
license notices just after the title page:</para>
|
||||
|
||||
<blockquote id="copyright-sample"><para>
|
||||
Copyright (c) YEAR YOUR NAME.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.2
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||
A copy of the license is included in the section entitled "GNU
|
||||
Free Documentation License".
|
||||
</para></blockquote>
|
||||
|
||||
<para>If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
||||
Texts, replace the "with...Texts." line with this:</para>
|
||||
|
||||
<blockquote id="inv-cover-sample"><para>
|
||||
with the Invariant Sections being LIST THEIR TITLES, with the
|
||||
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
|
||||
</para></blockquote>
|
||||
|
||||
<para>If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.</para>
|
||||
|
||||
<para>If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of free
|
||||
software license, such as the GNU General Public License, to permit
|
||||
their use in free software.</para>
|
||||
</sect1>
|
||||
</appendix>
|
|
@ -0,0 +1,277 @@
|
|||
<chapter id="gui"><title id="tgui">The Graphical User Interface</title>
|
||||
|
||||
<sect1><title>Opening a stream</title>
|
||||
|
||||
<para>To open a stream using the graphical interface, click on either
|
||||
:</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>"File" to open a file stored on your hard
|
||||
drive.</para></listitem>
|
||||
|
||||
<listitem><para>"Disc" to read a DVD or a VCD.</para></listitem>
|
||||
|
||||
<listitem><para>"Network" to read a network UDP stream
|
||||
or an HTTP stream.</para></listitem>
|
||||
|
||||
<listitem><para>"Satellite" to read directly from a satellite
|
||||
card.</para></listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>These four buttons, as well as the ones located in the "File"
|
||||
menu, actually open the same dialog box, but on different tabs.</para>
|
||||
|
||||
<sect2><title>The "open a stream" dialog box</title>
|
||||
|
||||
<para>You can specify directly the Media Resource Locator MRL, if you
|
||||
know the syntax that you have to use, but you may also use the different
|
||||
tabs, that will fill it automatically.</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>For a <command>File</command>, this is very simple, you
|
||||
only have to fill the path to the file.</para></listitem>
|
||||
|
||||
<listitem><para>For a <command>Disc</command>, you select
|
||||
the type of the disk, the path to the drive (looks like
|
||||
<filename>/dev/dvd</filename> on Unix, or <filename>D:</filename> on
|
||||
Windows), and the starting title and chapter.</para></listitem>
|
||||
|
||||
<listitem><para>For a <command>Network stream</command> :
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>if you use unicast mode, select <command>UDP</command>
|
||||
and the port used,</para>
|
||||
|
||||
<listitem><para>if you use multicast, select <command>UDP
|
||||
multicast</command>, enter the multicast address and the port ;</para>
|
||||
|
||||
<listitem><para>if you have a channel information service with
|
||||
mini-VLCS, select <command>Channel server</command>, and give its
|
||||
address ;</para>
|
||||
|
||||
<listitem><para>if you use HTTP streaming
|
||||
to do Video On Demand, select <command>HTTP</command> and give the
|
||||
address of your stream.</para></listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<listitem><para>For a <command>Satellite stream</command>, you have to
|
||||
give the frequency, the rate, the polarization, and the FEC of your
|
||||
stream.</para></listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Basic stream control</title>
|
||||
|
||||
<para>You have at your disposal all the classical control of a video
|
||||
player. For example when playing local streams or HTTP streams, you can
|
||||
pause, speed up or slow down the stream, go forth and back... Just use
|
||||
the corresponding buttons. </para>
|
||||
|
||||
<para>To go fullscreen, you can select the right options in the
|
||||
<emphasis>view</emphasis> menu, or press <keycap>f</keycap>. To go
|
||||
back to the normal mode, press <keycap>f</keycap>.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>DVD and VCD navigation</title>
|
||||
|
||||
<para>When reading a DVD or a VCD, you can change chapter and titles as
|
||||
you wish either by using the right-click menu or by using the options in
|
||||
the "Parameters" menu. These options are enabled only when you play a
|
||||
disk, or a disk through the network. </para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Programs, languages and subtitles</title>
|
||||
|
||||
<para>When reading a multiprogram stream, you can change the current
|
||||
program by selecting it in the "View/Programs" submenu on the bar, or by
|
||||
using the "right click" menu from the video output window. You can also
|
||||
change the title and the chapter by the same way.</para>
|
||||
|
||||
<para>In DVDs, if different angles are availables, they will be treated as
|
||||
different programs.</para>
|
||||
|
||||
<para>At any time you can change the audio/subtitles channel using either the
|
||||
"setting" menu from the interface or using the "right click" menu from
|
||||
the video output window.</para>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Preferences window</title>
|
||||
|
||||
<para>By choosing "Preferences" in the "Settings" menu, you will open
|
||||
the preferences window. This window is generated dynamically according
|
||||
to the modules that were compiled.</para>
|
||||
|
||||
<para>In every tab, you may click on "Save" to store your
|
||||
settings in your configuration file. (you can find it in
|
||||
<command>~/.vlc/vlcrc</command> on Unix/Linux systems, or in
|
||||
<command>Application Data\vlc\vlcrc</command> </para>
|
||||
|
||||
<sect2><title>Interface tab</title>
|
||||
|
||||
<para>In that tab, you can select which interface you would like
|
||||
to use on next start. Click on the choosen interface, click on
|
||||
<command>Select</command> then on <command>Save</command>.</para>
|
||||
|
||||
<para>There can be some configuration options available by clicking
|
||||
<command>Configure</command>. This depends on the interface
|
||||
chosen.</para>
|
||||
|
||||
<para>There are also a few generic settings, like color message or
|
||||
setting the verbosity level of the logs. You can also specify the
|
||||
path to the interface or to the plugin if they are not in the default
|
||||
directory. [FIX : compare with settings on other OS, where is the
|
||||
default file?] </para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Audio tab</title>
|
||||
|
||||
<para> In this tab, you can select and configure the audio output
|
||||
you would like to use on next start (this works juste like for the
|
||||
interface). You may also specify other settings such as enabling
|
||||
or disabling the audio output, the output volume level, the audio
|
||||
frequency, the number of channels on output, add desynchronization, or
|
||||
set audio output format and headphone spazialization effect.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Video tab</title>
|
||||
|
||||
<para>In this tab, you can select which video output will be used on
|
||||
next start, and add a video filter module, which means a filter that
|
||||
will alter the rendered image. For more information on modules, please
|
||||
look the Modules section. You may also specify some video settings, such
|
||||
as the window size, if you would like fullscreen display or the video
|
||||
zoom.</para>
|
||||
|
||||
<para>By using the <command>adjust</command> video filter module, you
|
||||
will be able to modify the Brightness, Contrast, Saturation and Hue of
|
||||
the video output.</para>
|
||||
|
||||
<para>There are also specific modules as wall which cut the output in
|
||||
many windows to make a video wall, transform module to rotate the image
|
||||
or invert module to invert the colors (who said it's useless?)</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Input tab</title>
|
||||
|
||||
<para>In this tab, you can enter the input method with options by
|
||||
default that will be used on next start.</para>
|
||||
|
||||
<para>Note that these are only <emphasis>default options</emphasis>,
|
||||
which means that they will be written in the appropriate field, but, you
|
||||
can of course change them.</para>
|
||||
|
||||
<para>You can configure the default addresses and port for network
|
||||
streaming :</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para>the server port for UDP streaming,</para></listitem>
|
||||
<listitem><para>the server port for UDP multicast streaming</para></listitem>
|
||||
<listitem><para>the channel server adress and the channel server if you have a channel information service based on mini-VLCS.</para></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Here you also can choose which network interface the videolan
|
||||
client will use to get the stream and the address of this interface.</para>
|
||||
|
||||
<para>The other options allow you to choose audio, channel, subtitles,
|
||||
the device of the DVD, the device of the VCD and the IP protocol of the
|
||||
stream (IPv6 or IPv4).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Decoders tab</title>
|
||||
|
||||
<para>In this tab, you can select which decoder (codec) you want to use
|
||||
for audio or video decoders. VLC normally automatically detects the
|
||||
right codec to use, so be sure to know what you are doing.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Stream ouput</title>
|
||||
|
||||
<para>In this tab you can configure the stream output capabilities.</para>
|
||||
|
||||
<para>Stream output is a new feature of VLC which allow you to save
|
||||
the stream that you are watching to a file, or to stream it in unicast or multicast.</para>
|
||||
|
||||
<para>This tab allows you to set up some options for this. You will
|
||||
be able to select the muxer used for the stream, ie PS, TS or AVI. PS
|
||||
and TS are parts of the MPEG norm. PS stands for Program Stream, it is
|
||||
usually used for files, whereas TS stands for Transport Stream, which
|
||||
is rather used for network streams. AVI means output to an AVI file or
|
||||
stream.</para>
|
||||
|
||||
<para>You may also select the <emphasis>access output</emphasis>,
|
||||
i.e. what the strem will be output to. You can choose
|
||||
beetween <emphasis>UDP</emphasis> (network stream) or
|
||||
<emphasis>file</emphasis>.</para>
|
||||
|
||||
<para>The Packetizer is the format of the output.</para>
|
||||
|
||||
<para>You can also enable or disable audio or video.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>CPU tab</title>
|
||||
|
||||
<para>This tab is dedicated to enabling or disabling support for
|
||||
CPU extensions: MMX support (every processors since Pentium MMX),
|
||||
3D! Now Support (for AMD K6-2, K6-3, Athlon and Duron processors),
|
||||
MMX EXT support, and SSE support (for Pentium III and Pentium IV
|
||||
processors).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<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's start, enqueue
|
||||
items in it or randomly read the files.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Miscellanous tab</title>
|
||||
|
||||
<para> In this tab, you can select which memcpy version you want to use.
|
||||
Some of them uses MMX or 3Dnow! extensions. You can also select the
|
||||
access module (module used to get the stream) and the the demux module
|
||||
(used to ... demux the stream).</para>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Miscellaneous</title>
|
||||
|
||||
<sect2><title>The Messages Window</title>
|
||||
|
||||
<para>This window is available by clicking on
|
||||
<emphasis>Messages</emphasis> in the <emphasis>View</emphasis> menu. It
|
||||
shows all the debug messages of VLC. If you have a problem with VLC,
|
||||
don't hesitate to open this window, as it may contain an interesting
|
||||
error message.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>The Playlist</title>
|
||||
|
||||
<para>VLC includes a simple playlist management system. By using the
|
||||
buttons which are in the playlist window, you can easily add or remove
|
||||
streams (whether these are files, disks, network streams, or satellites
|
||||
streams).</para>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
|
@ -0,0 +1,240 @@
|
|||
<para>There are VLC binaries available for the many OSes, but not for
|
||||
all supported OSes. If there are no binaries for your OS or if you want
|
||||
to change the default settings, you can compile VLC from sources.</para>
|
||||
|
||||
|
||||
<sect2><title>Under Windows</title>
|
||||
|
||||
<para>VLC works under Windows 95/98/ME/2000/XP.
|
||||
Download the Zipip file from the <ulink
|
||||
url="http://www.videolan.org/vlc/download-windows.html">VLC Windows
|
||||
download page</ulink>. Unzip the file in a directory to install
|
||||
VLC.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under BeOS</title>
|
||||
|
||||
<para>
|
||||
Download the Zip file from the <ulink
|
||||
url="http://www.videolan.org/vlc/download-beos.html">VLC BeOS download
|
||||
page</ulink>. Unzip the file in a directory to install VLC.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Mac OS X</title>
|
||||
|
||||
<para>
|
||||
|
||||
Download the Mac OS X package from the <ulink
|
||||
url="http://www.videolan.org/vlc/download-macosx.html">VLC
|
||||
MacOS X download page</ulink> . Double-click on the icon of the
|
||||
package : an icon will appear on your Desktop, right beside your
|
||||
drive(s). Open it and drag the VLC application from the resulting
|
||||
window to the place where you want to install it (it should be
|
||||
<filename>/Applications</filename>).
|
||||
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Linux Debian</title>
|
||||
|
||||
<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>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>apt-get update</userinput>
|
||||
<prompt># </prompt><userinput>apt-get install gnome-vlc vlc-plugin-a52 vlc-plugin-mad vlc-plugin-ogg libdvdcss2</userinput>
|
||||
</screen>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Linux Redhat, Mandrake and SuSE</title>
|
||||
|
||||
<para>For these distributions, use the RPM packages.</para>
|
||||
|
||||
<para>First, install the packages <emphasis>liba52</emphasis> and
|
||||
<emphasis>libmad0</emphasis> that should be packaged in your
|
||||
distribution. If they are not, try to find the RPMs on <ulink
|
||||
url="http://www.rpmfind.net/linux/RPM/">RPMfind.net</ulink> or search
|
||||
the Internet.</para>
|
||||
|
||||
<para>
|
||||
|
||||
Download the RPM packages of <emphasis>libdvdcss2</emphasis>,
|
||||
<emphasis>libdvdpsi1</emphasis>, <emphasis>vlc</emphasis>
|
||||
<emphasis>gnome-vlc</emphasis>, <emphasis>vlc-plugin-mad</emphasis>, <emphasis>vlc-plugin-ogg</emphasis>, <emphasis>vlc-plugin-a52</emphasis> from the
|
||||
<ulink url="http://www.videolan.org/vlc/download-linux.html">VLC Linux
|
||||
download page</ulink>.
|
||||
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Then install the RPM packages you have downloaded:
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>rpm -Uhv vlc-version.i586.rpm gnome-vlc-version.i586.rpm vlc-plugin-mad-version.i586.rpm
|
||||
vlc-plugin-ogg-version.i586.rpm vlc-plugin-a52-version.i586.rpm libdvdcss2-version.i586.rpm libdvdpsi1-version.i586.rpm</userinput>
|
||||
</screen>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Compile the sources by yourself (for every other OS)</title>
|
||||
|
||||
<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>
|
||||
|
||||
<sect3><title>Install the libraries</title>
|
||||
<para>
|
||||
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>a52dec</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>, <emphasis>libmad</emphasis>
|
||||
and <emphasis>faad2</emphasis> if you want to read MPEG 4 / DivX
|
||||
files,</para></listitem>
|
||||
|
||||
<listitem><para><emphasis>libogg</emphasis> and
|
||||
<emphasis>libvorbis</emphasis> if you want to read Ogg Vorbis
|
||||
files.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>Download the libraries from <ulink
|
||||
url="http://www.videolan.org/vlc/download-sources.html">VLC sources
|
||||
download page</ulink>.</para>
|
||||
|
||||
<para>For each library :</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>uncompress :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>tar xvzf library.tar.gz</userinput>
|
||||
</screen>
|
||||
<para>or</para>
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>tar xvjf library.tar.bz2</userinput>
|
||||
</screen>
|
||||
|
||||
<listitem><para>configure :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>cd library</userinput>
|
||||
<prompt>% </prompt><userinput>./configure --enable-shared</userinput>
|
||||
</screen>
|
||||
|
||||
<listitem><para>compile and install :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>make</userinput>
|
||||
<prompt># </prompt><userinput>make install</userinput>
|
||||
</screen>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
Check that the configuration file <filename>/etc/ld.so.conf</filename>
|
||||
contains the following line :
|
||||
</para>
|
||||
|
||||
<programlisting>
|
||||
/usr/local/lib
|
||||
</programlisting>
|
||||
|
||||
<para>If the line is not present, add-it and then run (as root):</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>ldconfig</userinput>
|
||||
</screen>
|
||||
|
||||
</sect3>
|
||||
|
||||
<sect3><title>Install VLC</title>
|
||||
|
||||
<para>Download the sources of the lastest release : get the
|
||||
file <filename>vlc-version.tar.gz</filename> from the <ulink
|
||||
url="http://www.videolan.org/vlc/download-sources.html">VLC sources
|
||||
download page</ulink>. Uncompress-it :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>tar xvzf vlc-version.tar.gz</userinput>
|
||||
<prompt>% </prompt><userinput>cd vlc-version</userinput>
|
||||
</screen>
|
||||
|
||||
<!-- bootstrap is already done is the tarballs -->
|
||||
|
||||
<para>To get the list of configuration options, do :</para>
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure --help</userinput>
|
||||
</screen>
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
<para>Examples of very simple configurations:</para>
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>if you want a basic VLC, do : </para>
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure</userinput>
|
||||
</screen>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>if you want the Gnome interface instead of the GTK
|
||||
interface (you will need the developement packages of Gnome) :</para>
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure --enable-gnome</userinput>
|
||||
</screen>
|
||||
</listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
Then, compile and install :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>make</userinput>
|
||||
<prompt>% </prompt><userinput>su</userinput>
|
||||
<prompt>Password: </prompt><userinput> [Root Password]</userinput>
|
||||
<prompt># </prompt><userinput>make install</userinput>
|
||||
</screen>
|
||||
|
||||
<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>
|
|
@ -0,0 +1,226 @@
|
|||
<!--
|
||||
<sect2><title>Under Windows</title>
|
||||
|
||||
<para>
|
||||
Download the Zip file for Windows from the <ulink
|
||||
url="http://www.videolan.org/vls/download.html">vls download
|
||||
page</ulink> and unzip-it in a directory.
|
||||
</para>
|
||||
|
||||
<note><para>
|
||||
|
||||
The Windows version of vls can only stream MPEG
|
||||
files stored on a hard drive. It cannot stream DVDs, satellite channels
|
||||
or real-time MPEG encoded videos.
|
||||
|
||||
</para></note>
|
||||
|
||||
<sect2><title>Under Linux Debian</title>
|
||||
|
||||
<para>
|
||||
Edit <filename>/etc/apt/sources.list</filename> and add the following line :
|
||||
</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>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>apt-get update</userinput>
|
||||
<prompt># </prompt><userinput>apt-get install libdvdcss2 vls-dvd</userinput>
|
||||
</screen>
|
||||
|
||||
<para>
|
||||
If you don't want to stream DVDs, type instead :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>apt-get update</userinput>
|
||||
<prompt># </prompt><userinput>apt-get install vls</userinput>
|
||||
</screen>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Linux RedHat, Mandrake or SuSE</title>
|
||||
|
||||
<para>
|
||||
Download the RPM package of libdvdcss from the <ulink
|
||||
url="http://www.videolan.org/libdvdcss/download.html">libdvdcss download page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Download the RPM package of libdvbpsi from the <ulink url="http://www.videolan.org/libdvbpsi/download.htm">libdvbpsi
|
||||
download page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Download the RPM package of libdvdread from <ulink
|
||||
url="http://www.dtek.chalmers.se/groups/dvd/redhat.shtm">Ogle's download page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Download the RPM packages <filename>vls</filename> and <filename>vls-dvd</filename> from the <ulink url="http://www.videolan.org/vls/download.html">vls download page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Then install the RPM packages you have downloaded :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>rpm -Uhv vls-version.i586.rpm vls-dvd-version.i586.rpm libdvdcss2-version.i586.rpm
|
||||
libdvbpsi1-version.i586.rpm libdvdread-version.i386.rpm</userinput>
|
||||
</screen>
|
||||
|
||||
|
||||
</sect2>
|
||||
|
||||
-->
|
||||
|
||||
<sect2><title>Under Linux or Unix</title>
|
||||
|
||||
<para>The method below is for any Unix or Linux supported by the
|
||||
Videolan Server. It explains how to compile and install vls and the
|
||||
needed librairies from sources.</para>
|
||||
|
||||
<sect3><title>Install the librairies</title>
|
||||
|
||||
<para>
|
||||
Many librairies are needed for particular uses :
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>libdvbpsi</emphasis> (always needed)</para></listitem>
|
||||
<listitem><para><emphasis>libdvdcss</emphasis> if you want to be able to access encrypted DVDs,</para></listitem>
|
||||
<listitem><para><emphasis>libdvdread</emphasis> if you want to be able to stream DVDs.</para></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
|
||||
Download the libraries from <ulink
|
||||
url="http://www.videolan.org/pub/videolan/vls/"></ulink> in the directory
|
||||
<filename>version/contrib</filename>.
|
||||
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For each librairie, uncompress, configure, compile and install :
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>tar xvzf library.tar.gz</userinput>
|
||||
<prompt>% </prompt><userinput>cd library</userinput>
|
||||
<prompt>% </prompt><userinput>./configure --enable-shared</userinput>
|
||||
<prompt>% </prompt><userinput>make</userinput>
|
||||
<prompt># </prompt><userinput>make install</userinput>
|
||||
</screen>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
Check that the configuration file <filename>/etc/ld.so.conf</filename>
|
||||
contains the following line :
|
||||
|
||||
</para>
|
||||
|
||||
<programlisting>
|
||||
/usr/local/lib
|
||||
</programlisting>
|
||||
|
||||
<para>If the line is not present, add-it and then run :</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>ldconfig</userinput>
|
||||
</screen>
|
||||
|
||||
</sect3>
|
||||
|
||||
<sect3><title>Install the VideoLAN Server</title>
|
||||
|
||||
<!--
|
||||
<para>
|
||||
Download the sources of the latest release : get the file
|
||||
<filename>vls-version.tar.gz</filename> from the <ulink url="http://www.videolan.org/vls/download.html">vls download page</ulink>. Uncompress-it :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>tar xvzf vls-version.tar.gz</userinput>
|
||||
<prompt>% </prompt><userinput>cd vls-version</userinput>
|
||||
</screen>
|
||||
-->
|
||||
|
||||
<para>
|
||||
|
||||
Get the most recent version of the VideoLAN Server from the public CVS :
|
||||
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>cvs -d:pserver:anonymous@cvs.videolan.org:/cvs/videolan login</userinput>
|
||||
</screen>
|
||||
|
||||
<para>
|
||||
There is no password. Type enter, then :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>cvs -d:pserver:anonymous@cvs.videolan.org:/cvs/videolan checkout -P -r v0_4_5 vls</userinput>
|
||||
</screen>
|
||||
|
||||
<para>
|
||||
To get the list of configuration options, do :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure --help</userinput>
|
||||
</screen>
|
||||
|
||||
<para>
|
||||
Then configure vls :
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>if you want a basic vls without DVD support, do :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure --disable-dvd</userinput>
|
||||
</screen>
|
||||
|
||||
</listitem>
|
||||
|
||||
<listitem><para>if you want a full vls with DVD support, do :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>./configure</userinput>
|
||||
</screen>
|
||||
|
||||
</listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
Then, compile and install :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>make</userinput>
|
||||
<prompt># </prompt><userinput>make install</userinput>
|
||||
</screen>
|
||||
|
||||
<para>
|
||||
|
||||
You can also do a <command>make uninstall</command>, <command>make
|
||||
clean</command> or <command>make distclean</command> as needed.
|
||||
|
||||
</para>
|
||||
|
||||
</sect3>
|
||||
</sect2>
|
|
@ -0,0 +1,13 @@
|
|||
<chapter id="install"><title id="tinstall">Installing VLC</title>
|
||||
|
||||
|
||||
<sect1><title>Installing VLC</title>
|
||||
&install-vlc;
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Uninstalling VLC</title>
|
||||
&uninstall-vlc;
|
||||
</sect1>
|
||||
|
||||
|
||||
</chapter>
|
|
@ -0,0 +1,261 @@
|
|||
<chapter id="intro"><title id="tintro">Introduction</title>
|
||||
|
||||
<sect1><title>What is the VideoLAN project ?</title>
|
||||
|
||||
<sect2><title>Overview</title>
|
||||
|
||||
<para>
|
||||
|
||||
VideoLAN is a complete software solution for video streaming, developed
|
||||
by students of the <ulink url="http://www.ecp.fr">Ecole Centrale
|
||||
Paris</ulink> and developers from all over the world, under the
|
||||
<ulink url="http://www.gnu.org/copyleft/gpl.html">GNU General Public
|
||||
License</ulink> (GPL). VideoLAN is designed to stream MPEG videos on high
|
||||
bandwidth networks.
|
||||
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
The VideoLAN solution includes :
|
||||
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>the VideoLAN Server (VLS), which can stream MPEG 1 and 2
|
||||
files, DVDs, digital satellite channels, digital terrestial television
|
||||
channels and live videos on the network in unicast or multicast,</para>
|
||||
|
||||
<listitem><para>the VideoLAN Client (VLC), which can be used as a server
|
||||
to stream MPEG 1, 2 and 4 files and DVDs on the network in unicast or
|
||||
multicast ; or used as a client to receive, decode and display MPEG streams
|
||||
under multiple operating systems.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
|
||||
Here is an illustration of the complete VideoLAN solution :
|
||||
|
||||
</para>
|
||||
|
||||
<figure><title>Global VideoLAN solution</title>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata fileref="plan-videolan-640.&magic;" format="&magic;" scalefit="1" scale="60">
|
||||
</imageobject>
|
||||
</mediaobject>
|
||||
</figure>
|
||||
|
||||
<para>
|
||||
|
||||
More details about the project can be found on the
|
||||
<ulink url="http://www.videolan.org">VideoLAN Web site</ulink>.
|
||||
|
||||
</para>
|
||||
|
||||
<sect2><title>VideoLAN software</title>
|
||||
|
||||
<simplesect><title>VideoLAN Client</title>
|
||||
|
||||
<para>
|
||||
|
||||
The VideoLAN Client (VLC) works on many platforms : Linux, Windows, Mac
|
||||
OS X, BeOS, *BSD, Solaris, Familiar Linux and QNX. It can read :
|
||||
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>MPEG 1, MPEG 2 and MPEG 4 / DivX files from a hard disk
|
||||
or a CD-ROM drive,</para>
|
||||
|
||||
<listitem><para>DVDs and VCDs,</para>
|
||||
|
||||
<listitem><para>from a satellite card,</para>
|
||||
|
||||
<listitem><para>MPEG 1, MPEG 2 and MPEG 4 streams from the
|
||||
network sent by VLS or VLC's stream output.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>VLC can also be used as a server to stream :</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>MPEG 1, MPEG 2 and MPEG 4 / DivX files,</para>
|
||||
|
||||
<listitem><para>and DVDs,</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>to :</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>one machine (i.e. to one IP address) : this is called
|
||||
<emphasis>unicast</emphasis> ;</para>
|
||||
|
||||
<listitem><para>a dynamic group of machines that the clients can join or leave
|
||||
(i.e. to a multicast IP address) : this is called
|
||||
<emphasis>multicast</emphasis>.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<note><para>VLC doesn't work on Mac OS 9, and will
|
||||
probably never do.</para></note>
|
||||
|
||||
<simplesect><title>VideoLAN Server</title>
|
||||
|
||||
<para>
|
||||
|
||||
The VideoLAN Server (VLS) can stream :
|
||||
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>an MPEG 1 or MPEG 2 file stored on a hard drive or on a
|
||||
CD,</para>
|
||||
|
||||
<listitem><para>a DVD located in a local DVD drive or copied on a hard
|
||||
disk,</para>
|
||||
|
||||
<listitem><para>a satellite card or a digital terrestial television card,</para>
|
||||
|
||||
<listitem><para>an MPEG encoding card ;</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>to :</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>one machine (i.e. to one IP address) : this is called
|
||||
<emphasis>unicast</emphasis> ;</para>
|
||||
|
||||
<listitem><para>a dynamic group of machines that the clients can join or leave
|
||||
(i.e. to a multicast IP address) : this is called
|
||||
<emphasis>multicast</emphasis>.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
|
||||
A Pentium 100 MHz with 32 MB of memory should be enough to send one
|
||||
stream on the network. When streaming a lot of videos stored on a
|
||||
hard drive, the actual limitation is not the processor but the hard
|
||||
drive and the network connection.
|
||||
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
VLS works under Linux and Windows, but only the Linux version
|
||||
have all the functionalities. The Windows port of vls can
|
||||
only stream a video from a file.
|
||||
|
||||
</para>
|
||||
|
||||
<sect1><title>How can I use VideoLAN ?</title>
|
||||
|
||||
<sect2><title>The documentation</title>
|
||||
|
||||
<para>
|
||||
|
||||
The user documentation of the VideoLAN project is composed of four documents :
|
||||
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>the <ulink
|
||||
url="http://www.videolan.org/doc/videolan-quickstart/">VideoLAN
|
||||
Quickstart</ulink>. This document will give you a quick overview of
|
||||
of VLC, VLS, and the Video On Demand
|
||||
solution.</para>
|
||||
|
||||
<listitem><para>the <ulink
|
||||
url="http://www.videolan.org/doc/videolan-howto/">VideoLAN
|
||||
HOWTO</ulink>. This document is the complete guide of the VideoLAN
|
||||
streaming solution.</para>
|
||||
|
||||
<listitem><para>the <ulink
|
||||
url="http://www.videolan.org/doc/vlc-user-guide/">VLC user
|
||||
guide</ulink>. This document is the complete guide for VLC.</para>
|
||||
|
||||
<listitem><para>the <ulink
|
||||
url="http://www.videolan.org/doc/faq-vlc/faq/">VLC FAQ</ulink>. This
|
||||
document contains Frequently Asked Questions of VLC users.</para>
|
||||
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
|
||||
The latest version of these documents can be found on the <ulink
|
||||
url="http://www.videolan.org/doc/">VideoLAN Web site</ulink>.
|
||||
|
||||
</para>
|
||||
|
||||
<sect2><title>User support</title>
|
||||
|
||||
<para>
|
||||
|
||||
If you have problems using VideoLAN, and if you don't find the
|
||||
answer to your problems in the documentation, please look at the
|
||||
<ulink url="http://www.via.ecp.fr/ml/videolan">online archive of the
|
||||
mailing-lists</ulink>. There are two English-speaking mailing-lists for
|
||||
the users :
|
||||
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><emphasis>vlc@videolan.org</emphasis> for the questions
|
||||
on VLC,</para>
|
||||
|
||||
<listitem><para><emphasis>streaming@videolan.org</emphasis> for the questions
|
||||
on VLS, mini-VLCS and the network.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
|
||||
If you want to subscribe or unsubscribe to the mailing-lists,
|
||||
please go to the <ulink url="http://www.videolan.org/support/lists.html">
|
||||
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>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<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>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>command_to_be_typed_as_regular_user</userinput>
|
||||
</screen>
|
||||
|
||||
</itemizedlist>
|
|
@ -0,0 +1 @@
|
|||
<!ENTITY magic "eps">
|
|
@ -0,0 +1 @@
|
|||
<!ENTITY magic "jpg">
|
|
@ -0,0 +1 @@
|
|||
<!ENTITY magic "jpg">
|
|
@ -0,0 +1,740 @@
|
|||
<chapter id="modules"><title id="tmodules">Modules and options for VLC</title>
|
||||
|
||||
<sect1><title>The modules</title>
|
||||
|
||||
<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 :
|
||||
</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>
|
||||
|
||||
|
||||
<sect1><title>Video outputs</title>
|
||||
|
||||
<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>
|
||||
|
||||
<para><emphasis>For Unix with X11 servers only</emphasis></para>
|
||||
|
||||
<para>This is the basic x11 video output. It only requires a
|
||||
working X11 server. You will need xlibs headers to compile it
|
||||
(<emphasis>xlibs-dev</emphasis> package on Debian systems).</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>xvideo</title>
|
||||
|
||||
<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 modern cards). It uses hardware acceleration for YUV
|
||||
transformation and rescaling.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>sdl</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This video output uses sdl libraries. You need at least version
|
||||
1.1.6 of this libraries.</para>
|
||||
|
||||
<para> You may indicate the path to the <emphasis>sdl-config</emphasis>
|
||||
program with the <command> --with-sdl-config-path=PATH </command>
|
||||
switch, when running the configre script.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>directx</title>
|
||||
|
||||
<para><emphasis>default: enabled on win32</emphasis></para>
|
||||
|
||||
<para><emphasis>For Windows only</emphasis></para>
|
||||
|
||||
<para>This video output uses Microsoft Direct X libraries. It is
|
||||
recommended for the win32 port.</para>
|
||||
|
||||
<para>You may indicate the path to directX libraries and headers with
|
||||
the <command>--with-directx=PATH</command> switch, when running the
|
||||
configure script.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>wingdi</title>
|
||||
|
||||
<para><emphasis>default: enabled on win32</emphasis></para>
|
||||
|
||||
<para><emphasis>For Windows only</emphasis></para>
|
||||
|
||||
<para>This video output uses GDI. It is designed for users who don't
|
||||
have Direct X, but the perfs are very low. If you have DirectX, do not
|
||||
use it.</para>
|
||||
</sect2>
|
||||
|
||||
|
||||
<sect2><title>fb</title>
|
||||
|
||||
<para><emphasis>default: enabled on Linux</emphasis></para>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis></para>
|
||||
|
||||
<para>This is the frame buffer video output. It requires that your
|
||||
kernel was compiled with frame buffer support.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>glide</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This video output uses Glide libraries (hardware acceleration for
|
||||
3Dfx cards).</para>
|
||||
|
||||
<para>You may indicate the path to the library with the
|
||||
<command>--with-glide=PATH</command> configure option. /para></sect2>
|
||||
|
||||
<sect2><title>mga</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis></para>
|
||||
|
||||
<para>This module provides hardware acceleration for Matrox cards under
|
||||
Linux.</para></sect2>
|
||||
|
||||
<sect2><title>ggi</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>aa</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is the ASCII Art Video Output. This video output uses the
|
||||
aalib library to display video through ASCII art. It requires aalib
|
||||
headers (<emphasis>aalib1-dev</emphasis> package under Debian) to
|
||||
compile.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>svgalib</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis>
|
||||
|
||||
<para>This is a video output for the SVGAlib library.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>qte</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis>
|
||||
|
||||
<para><emphasis>For iPaq only</emphasis>
|
||||
|
||||
<para>This is a video output for QT Embedded, an iPaq-specifiq graphical
|
||||
library.</para>
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Video filters modules</title>
|
||||
|
||||
<para>These modules allow you to perform modifications on the rendered
|
||||
image.</para>
|
||||
|
||||
<sect2><title>deinterlace</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This filter deinterlaces video. It is useful with streams coming
|
||||
from a digital satellite channel or digital terrestial television
|
||||
channels.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>wall</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This filter allows you to have the video cut in pieces in several
|
||||
windows, which you can order as you wish. It can be used to generate
|
||||
image walls with several sources. Start it with :</para>
|
||||
|
||||
<screen>
|
||||
<prompt>% </prompt><userinput>vlc --filter wall:XxY ....</userinput>
|
||||
</screen>
|
||||
|
||||
<para>in order to have the video cut in <emphasis>X</emphasis> rows and
|
||||
<emphasis>Y</emphasis> columns</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>distort</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This filter adds a distortion effect to the video. Who said it was
|
||||
useless ? :-)</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>transform</title>
|
||||
|
||||
<para><emphasis>default: enable</emphasis></para>
|
||||
|
||||
<para>This filter rotates the video window of 90 degrees.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>invert</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This filter inverses colors.</para>
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1><title>Sound outputs</title>
|
||||
|
||||
<para>These modules allow you to choose the way the sound will be output
|
||||
to your audio system.</para>
|
||||
|
||||
<sect2><title>oss</title>
|
||||
|
||||
<para><emphasis>default: enabled on Linux</emphasis></para>
|
||||
|
||||
<para><emphasis>For Unix/Linux only</emphasis></para>
|
||||
|
||||
<para>This is the audio output for OSS (Open Sound System) output
|
||||
(<filename>/dev/dsp</filename>, for exemple, under Linux). It requires
|
||||
that your kernel was compiled with support for your sound card.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>alsa</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis></para>
|
||||
|
||||
<para>This is the sound output for ALSA (Advanced Linux Sound
|
||||
Architecture). It only works under Linux, and it requires that you
|
||||
installed the ALSA drivers and libraries.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>esd</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Unix/Linux only</emphasis></para>
|
||||
|
||||
<para>This sound output has ESD (Enlightened Sound Daemon) support
|
||||
(usually used with Gnome). You must have the daemon and its libraries
|
||||
installed.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>arts</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Unix/Linux only</emphasis></para>
|
||||
|
||||
<para>This sound output has aRts (KDE's sound server) support. You must
|
||||
have the daemon and its libraries installed.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>waveout</title>
|
||||
|
||||
<para><emphasis>default: enabled on win32</emphasis></para>
|
||||
|
||||
<para>This is the Wave output, which is used by the win32 port.</para>
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1><title>Input modules</title>
|
||||
|
||||
<para>These modules allow VLC to read its streams from different
|
||||
sources.</para>
|
||||
|
||||
<sect2><title>dvdplay</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the regular DVD input module. It will need
|
||||
<emphasis>libdvdcss</emphasis> for DVD decryption (see the <ulink
|
||||
url="http://developers.videolan.org/libdvdcss/">libdvdcss page</ulink>)
|
||||
and <emphasis>libdvdplay</emphasis> for DVD navigation (see the <ulink
|
||||
url="http://developers.videolan.org/libdvdplay/">libdvdplay</ulink>
|
||||
page).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>dvdold</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the old DVD input module. It uses
|
||||
<emphasis>libdvdcss</emphasis> for DVD decryption (see the
|
||||
<ulink url="http://developers.videolan.org/libdvdcss/">libdvdcss
|
||||
page</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>dvdread</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is an alternative to the previous ones. It uses
|
||||
<emphasis>libdvdread</emphasis> for DVD reading (see the <ulink
|
||||
url="http://www.dtek.chalmers.se/groups/dvd/downloads.shtml">Ogle
|
||||
download page</ulink>) and <emphasis>libdvdcss</emphasis>
|
||||
for DVD decryption (see the <ulink
|
||||
url="http://developers.videolan.org/libdvdcss/">libdvdcss
|
||||
page</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>vcd</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the VideoCD input.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>http</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the HTTP input. You can use it for Video On Demand.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>satellite</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is an input module that allows to read
|
||||
directly from a Hauppauge WinTV Nova card under Linux.
|
||||
It requires drivers 0.9.4 available from <ulink
|
||||
url="http://www.linuxtv.org/">linuxtv.org</ulink>.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>v4l</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis></para>
|
||||
|
||||
<para>This module allows to get Video4Linux streams.</para>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1><title>Demuxers</title>
|
||||
|
||||
<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
|
||||
format.</para>
|
||||
|
||||
<sect2><title>avi</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows you to read <filename>.avi</filename> files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>asf</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows you to read <filename>.asf</filename> files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>aac</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows to you read AAC files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>ogg</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows to you read OGG files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>rawdv</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows to you read DV files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>dvbpsi</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module allows to demux streams from a satellite card.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>mp4</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This module is the MPEG-4 demuxer.</para>
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
|
||||
<sect1><title>Interface modules</title>
|
||||
|
||||
<para>These modules allow you to choose the interface you want to use.</para>
|
||||
|
||||
<sect2><title>gtk</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the GTK+ interface. It needs gtk libraries
|
||||
(<emphasis>libgtk1.2</emphasis> package on Debian) and headers files
|
||||
if you are compiling it (<emphasis>libgtk1.2-dev</emphasis> package on
|
||||
Debian). Note that it can also be used under Windows.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>gnome</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Linux only</emphasis></para>
|
||||
|
||||
<para>This is the Gnome interface. It needs gnome libraries
|
||||
(<emphasis>libgnome32</emphasis> package under Debian) and headers
|
||||
(<emphasis>libgnome-dev</emphasis> package under Debian) if you wish to
|
||||
compile it.</para> </sect2>
|
||||
|
||||
<sect2><title>intfwin</title>
|
||||
|
||||
<para><emphasis>default: enabled on win32</emphasis></para>
|
||||
|
||||
<para><emphasis>For Windows only</emphasis></para>
|
||||
|
||||
<para>This is the Windows native interface. It requires
|
||||
Borland C++ builder to compile. You may use the
|
||||
<command>--with-bc-builder=PATH</command> option to specify the path to
|
||||
this application.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>qt</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is the QT interface module. You will need the libraries
|
||||
(<emphasis>libqt2</emphasis> package on Debian) and headers
|
||||
(<emphasis>libqt-dev</emphasis> package under Debian) if you wish to
|
||||
compile it.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>kde</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is the KDE interface module. You will need the libraries
|
||||
(<emphasis>kdelibs3</emphasis> package on Debian) and headers
|
||||
(<emphasis>kde-devel</emphasis> package under Debian) if you wish to
|
||||
compile it.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>rc</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the Remote Control interface module. It allows you
|
||||
to control VLC via commands, such as <emphasis>play</emphasis>,
|
||||
<emphasis>stop</emphasis>, etc... or via a script.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>ncurses</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is a text interface, using ncurses library.
|
||||
You will need ncurses headers if you want to compile it
|
||||
(<emphasis>libncurses5-dev</emphasis> package on Debian).</para>
|
||||
</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 <filename>doc/lirc/example.lircrc</filename>).</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>wxwindows</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>The wxWindows interface is a portable interface meant to
|
||||
replace win32, gnome and Gtk interface, but it is not completely
|
||||
finished.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>opie</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is an interface plugin for the Qt Embedded library (iPaq
|
||||
graphical library).</para>
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
|
||||
<sect1><title>Codec modules</title>
|
||||
|
||||
<para>The following modules add codec (ie, compression formats)
|
||||
support.</para>
|
||||
|
||||
<sect2><title>a52</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is a better AC3/A52 decoder than the built-in one, based on
|
||||
liba52 (see the <ulink url="http://liba52.sourceforge.net/">liba52 web
|
||||
site</ulink>.<para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>ffmpeg</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is a free MPEG-4/DivX/OpenDivX codec : ffmpeg (see the <ulink
|
||||
url="http://ffmpeg.sourceforge.net/">ffmpeg web site</ulink>.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>vorbis</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This codec allows you to read the OGG/Vorbis files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>dv</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This codec allows you to read DV-encoded files.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>xvid</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This codec allows you to read files encoded with Xvid (see <ulink url="http://www.xvid.org/">Xvid web site</ulink>).</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>mad</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This codec is a very smart MP3 decoder, that only uses integers.
|
||||
This allows its use for CPU which don't handle floating point numbers
|
||||
(on PDA, for exemple).</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>faad</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>Faad is an MPEG-4 audio decoder (see the <ulink
|
||||
url="http://faac.sourceforge.net/">FAAC web site</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>tarkin</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>tarkin is a new codec (experimental) by the Ogg Project (see the
|
||||
<ulink url="http://www.vorbis.com">Ogg Vorbis web site</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
|
||||
<sect2><title>theora</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>theora is an experimental video codec by the Ogg Project (see the
|
||||
<ulink url="http://www.vorbis.com">Ogg Vorbis web site</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>cinepak</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This is the codec for the Cinepak format.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>tremor</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para>This is an Ogg/Vorbis codec that only makes integer calculus,
|
||||
which allow its use on CPU which don't have floating point support
|
||||
(see the <ulink url="http://www.vorbis.com">Ogg Vorbis web
|
||||
site</ulink>).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1><title>OS support modules</title>
|
||||
|
||||
<para>The following modules add support for different OSs.</para>
|
||||
|
||||
<sect2><title>macosx</title>
|
||||
|
||||
<para><emphasis>default: enabled on MacOS X</emphasis></para>
|
||||
|
||||
<para><emphasis>For MacOS X only</emphasis></para>
|
||||
|
||||
<para>This is the MacOS X support module, including a native
|
||||
interface.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>qnx</title>
|
||||
|
||||
<para><emphasis>default: enabled on qnx</emphasis></para>
|
||||
|
||||
<para><emphasis>For QNX only</emphasis></para>
|
||||
|
||||
<para>This is the QNX RTOS support module.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
|
||||
<sect1><title>Miscellaneous</title>
|
||||
|
||||
<para>This section describes a few more modules that don't belong to any
|
||||
of the categories described before.</para>
|
||||
|
||||
<sect2><title>sout</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>Stream Output is a new feature of VLC that allows
|
||||
it to stream an MPEG-1, MPEG-2 or MPEG-4/DivX file or a DVD.</para>
|
||||
|
||||
<para>For more details, please have a look at the <xref linkend="gui"
|
||||
endterm="tgui"> or <xref linkend="cmdline" endterm="tcmdline">
|
||||
sections.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>test-suite</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></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
|
||||
plugin is built.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>slp</title>
|
||||
|
||||
<para><emphasis>default: enabled</emphasis></para>
|
||||
|
||||
<para>This enables the SLP service discovery protocol.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>xosd</title>
|
||||
|
||||
<para><emphasis>default: disabled</emphasis></para>
|
||||
|
||||
<para><emphasis>For Unix only</emphasis></para>
|
||||
|
||||
<para>This plugin outputs the current stream to an "OSD" (On Screen
|
||||
Display).</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
|
||||
|
||||
<sect1><title>Compilation Options</title>
|
||||
|
||||
<para>There are a few options that you can set when running the
|
||||
configure script, which are not related to modules.</para>
|
||||
|
||||
<para>You can have a look at these options by typing :</para>
|
||||
|
||||
<screen>
|
||||
<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 VLC for (if not guessed
|
||||
correctly),...</para>
|
||||
|
||||
<para>You can also choose to enable or disable some optimizations.</para>
|
||||
|
||||
<sect2><title>--disable-plugins</title>
|
||||
|
||||
<para>If you select this option, no plugins will be enabled. This is
|
||||
definitely not recommended, as you would get a very poor VLC, and should
|
||||
only be used for testing purposes.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
</chapter>
|
|
@ -0,0 +1,46 @@
|
|||
<para>
|
||||
Vls can stream MPEG 1 or MPEG 2 files that meet two
|
||||
critera :
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para>the file must be MPEG <emphasis>PS</emphasis>
|
||||
(Program Stream) or MPEG <emphasis>TS</emphasis> (Transport Stream),
|
||||
that contain video and audio multiplexed. Vls cannot stream MPEG
|
||||
<emphasis>ES</emphasis> (Elementary Stream), i.e. a file with only audio
|
||||
or video.</para>
|
||||
|
||||
<para>In order to know if an MPEG file is MPEG <emphasis>PS</emphasis>,
|
||||
MPEG <emphasis>TS</emphasis> or MPEG <emphasis>ES</emphasis>, read the
|
||||
file with vlc and look at the messages (select in the menu
|
||||
<emphasis>View / Messages</emphasis>, or use the command line
|
||||
<command>vlc -v</command>) and look for a
|
||||
line :</para>
|
||||
|
||||
<programlisting>
|
||||
module: locking demux module `mpeg_XX'
|
||||
</programlisting>
|
||||
|
||||
<para>If <emphasis>XX = ps</emphasis> or <emphasis>XX =
|
||||
ts</emphasis>, then your file is MPEG <emphasis>PS</emphasis> and
|
||||
MPEG <emphasis>TS</emphasis> respectively, and you may be able to
|
||||
stream it. If <emphasis>XX = es</emphasis>, then your file is MPEG
|
||||
<emphasis>ES</emphasis> and is not streamable.</para>
|
||||
|
||||
<listitem><para>the sequence header of the video must repeat itself regularly,
|
||||
which is often the case with MPEG 2, but very rare with MPEG 1. There is
|
||||
no easy way to know if the sequence header is repeated regularly. Files
|
||||
with a <emphasis>.vob</emphasis> extension are normally MPEG
|
||||
2 files and files with <emphasis>.mpg</emphasis> or
|
||||
<emphasis>.mpeg</emphasis> extension or
|
||||
usually
|
||||
MPEG 1 files.</para>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>You can download this streamable
|
||||
MPEG 2 PS file for your tests : <ulink
|
||||
url="ftp://ftp.videolan.org/pub/videolan/streams/presentation/presentation_short.vob"
|
||||
>presentation_short.vob</ulink>.</para>
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
<sect2><title>Under Windows</title>
|
||||
|
||||
<para>Click on the <command>Uninstall VLC</command> icon that was
|
||||
created during installation.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under BeOS</title>
|
||||
|
||||
<para>Delete the <filename>vlc-version</filename>
|
||||
directory. You can also remove the configuration file
|
||||
<filename>/boot/home/config/settings/vlcrc</filename>.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Mac OS X</title>
|
||||
|
||||
<para>Drag the VLC application to your trash can.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Linux Debian</title>
|
||||
|
||||
<para>Remove the packages that you installed :</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>apt-get remove --purge vlc-gnome vlc-mad libdvdcss2 libdvbpsi1</userinput>
|
||||
</screen>
|
||||
</sect2>
|
||||
|
||||
<sect2><title>Under Linux Redhat, Mandrake and SuSE</title>
|
||||
|
||||
<para>
|
||||
Uninstall the RPM packages that you installed :
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>rpm -e vlc-version vlc-mad-version vlc-gnome-version
|
||||
libdvdcss2-version libdvdpsi1-version</userinput>
|
||||
</screen>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2><title>If you compiled VLC from sources</title>
|
||||
|
||||
|
||||
<para>Go to the directory containing VLC sources and execute :</para>
|
||||
|
||||
<screen>
|
||||
<prompt># </prompt><userinput>make uninstall</userinput>
|
||||
</screen>
|
||||
|
||||
<para>Then you can remove the VLC sources.</para>
|
||||
</sect2>
|
Loading…
Reference in New Issue