* Desperate attempt to improve audio output ;
[vlc.git] / 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 "May 19, 2002"
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, gvlc, gnome-vlc, qvlc \- The VideoLAN Client
20 .SH SYNOPSIS
21 .B vlc
22 .RI [ OPTIONS ]
23 .RI [ PARAMETERS ]
24 .RI [ ITEMS ]...
25 .SH DESCRIPTION
26 This manual page documents briefly the
27 .B vlc
28 , a free MPEG, MPEG2 and DVD player.
29 .SH ITEMS
30 .B vlc
31 recognizes several URL-style items:
32 .TP
33 .B *.mpg, *.vob
34 Plain MPEG-1/2 files
35 .B *.avi
36 AVI files, such as DivX movies
37 .TP
38 .B dvd:[<device>][@<raw device>][@[<title>][,[<chapter>][,<angle>]]]
39 DVD device (for instance dvd:/dev/dvd). The raw device is optional and
40 must have been prepared beforehands.
41 .TP
42 .B vcd:<device>
43 VCD device (for instance dvd:/dev/cdrom).
44 .TP
45 .B udpstream:[@[<multicast address>][:<local port>]]
46 UDP stream, such as one sent by VideoLAN Server or VideoLAN miniserver.
47 Usually "udpstream:" is enough.
48 .TP
49 .B vlc:<command>
50 Execute a play-list command. Commands are :
51 .B loop
52 (loop the playlist),
53 .B pause
54 (pause execution of other items), and
55 .B quit
56 (close VLC).
57 .SH OPTIONS
58 .B vlc
59 follows the usual GNU command line syntax, with long
60 options starting with two dashes (`-').
61 For a precise description of options, please use "vlc --help".
62
63 .SH SEE ALSO
64 .BR vls (1), vlms (1)
65 .br
66 .SH AUTHOR
67 This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others).