]> git.sesse.net Git - vlc/blob - doc/vlc.1
* modules/codec/ffmpeg/demux.c: a few fixes.
[vlc] / doc / vlc.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH VLC 1 "Dec 11, 2003"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 vlc, wxvlc, svlc, gvlc, kvlc, qvlc \- the VLC media player
20 .SH SYNOPSIS
21 .B vlc
22 .RI [ OPTIONS ]
23 .RI [ ITEMS ]...
24 .SH DESCRIPTION
25 This manual page documents briefly the
26 .B VLC
27 multimedia player and server.
28
29 .SH OPTIONS
30 .B VLC
31 follows the usual GNU command line syntax, with long
32 options starting with two dashes (`-').
33 For a precise description of options, please use "vlc --help".
34
35 The complete list of
36 .B VLC
37 options depends on what plugins are installed because they automatically
38 add their own options. Please use "vlc --longhelp" for a complete list of
39 available options.
40
41 .SH ITEMS
42 .B VLC
43 recognizes several URL-style items:
44 .TP
45 .B *.mpg, *.vob, *.avi, *.mp3, *.ogg
46 Various multimedia file formats
47 .TP
48 .B dvd:[<device>][@<raw device>][@[<title>][,[<chapter>][,<angle>]]]
49 DVD device (for instance dvd:/dev/dvd). The raw device is optional and
50 must have been prepared beforehands.
51 .TP
52 .B vcd:<device>
53 VCD device (for instance vcd:/dev/cdrom).
54 .TP
55 .B udp:[@[<multicast address>][:<local port>]]
56 UDP stream, such as one sent by VLS or another VLC.
57 Usually "udp:" is enough.
58 .TP
59 .B vlc:<command>
60 Execute a playlist command. Commands are :
61 .B pause
62 (pause execution of other items), and
63 .B quit
64 (close VLC).
65
66 .SH SEE ALSO
67 .BR vls (1)
68 .br
69 .SH AUTHOR
70 This manual page was written by Sam Hocevar <sam@zoy.org>, for the Debian
71 GNU/Linux system (but may be used by others).