]> git.sesse.net Git - vlc/blobdiff - doc/vlc.1
Use var_InheritString for --decklink-video-connection.
[vlc] / doc / vlc.1
index 6a769ee17fad5dfdb74784f786c5cfed169a0fab..45f0d0c3f9e9ecad5dacc87ef2d4b68c11d7e5dd 100644 (file)
--- a/doc/vlc.1
+++ b/doc/vlc.1
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH VLC 1 "May 19, 2002"
+.TH VLC 1 "Feb 14, 2005"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7)
 .SH NAME
-vlc, gvlc, gnome-vlc, kvlc, qvlc \- The VideoLAN Client
+vlc, qvlc, svlc, nvlc, rvlc, cvlc \- the VLC media player
 .SH SYNOPSIS
 .B vlc
 .RI [ OPTIONS ]
 .RI [ ITEMS ]...
 .SH DESCRIPTION
 This manual page documents briefly the
-.B vlc
-, a free MPEG, MPEG2 and DVD player.
+.B VLC
+multimedia player and server.
+
+.SH OPTIONS
+.B VLC
+follows the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+For a precise description of options, please use "vlc \-\-help".
+
+The complete list of
+.B VLC
+options depends on what plugins are installed because they automatically
+add their own options. Please use "vlc \-\-longhelp \-\-advanced" for a
+complete list of available options.
+
 .SH ITEMS
-.B vlc
+.B VLC
 recognizes several URL-style items:
 .TP
-.B *.mpg, *.vob
-Plain MPEG-1/2 files
-.B *.avi
-AVI files, such as DivX movies
+.B *.mpg, *.vob, *.avi, *.mp3, *.ogg
+Various multimedia file formats
+.TP
+.B dvd://[<device>][@<raw device>][@[<title>][:[<chapter>][:<angle>]]]
+DVD device (for instance dvd:///dev/dvd). The raw device is optional and
+must have been prepared beforehand.
 .TP
-.B dvd:[<device>][@<raw device>][@[<title>][,[<chapter>][,<angle>]]]
-DVD device (for instance dvd:/dev/dvd). The raw device is optional and
-must have been prepared beforehands.
+.B vcd://[<device>][@{E|P|E|T|S}[<number>]]
+VCD device (for instance vcd:///dev/cdrom).
 .TP
-.B vcd:<device>
-VCD device (for instance dvd:/dev/cdrom).
+.B udp://[@[<multicast address>][:<local port>]]
+UDP stream, such as one sent by VLS or another VLC.
+Usually "udp://" is enough.
 .TP
-.B udpstream:[@[<multicast address>][:<local port>]]
-UDP stream, such as one sent by VideoLAN Server or VideoLAN miniserver.
-Usually "udpstream:" is enough.
+.B http://<server address>[:<server port>]/[<file>]
+HTTP stream
 .TP
-.B vlc:<command>
-Execute a play-list command. Commands are :
-.B loop
-(loop the playlist),
+.B rtsp://<server address>[:<server port>]/<stream name>
+RTSP Video On Demand stream
+.TP
+.B vlc://<command>
+Execute a playlist command. Commands are:
 .B pause
 (pause execution of other items), and
 .B quit
 (close VLC).
-.SH OPTIONS
-.B vlc
-follows the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-For a precise description of options, please use "vlc --help".
 
 .SH SEE ALSO
-.BR vls (1), vlms (1)
-.br
+Online documentation: http://www.videolan.org/doc/
+.PP
 .SH AUTHOR
-This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others).
+This manual page was written by Sam Hocevar <sam@zoy.org>, for the Debian
+GNU/Linux system (but may be used by others).