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