mirror of https://github.com/tLDP/LDP
337 lines
9.6 KiB
Plaintext
337 lines
9.6 KiB
Plaintext
<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>
|