vlc.1 3.24 KB
Newer Older
1 2 3 4
.\"                                      Hey, EMACS: -*- nroff -*-
.\" 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)
5
.TH VLC 1 "Feb 14, 2005"
6 7 8 9 10 11 12 13 14 15 16 17 18
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
19
vlc, qvlc, svlc, nvlc, rvlc, cvlc \- the VLC media player
20 21
.SH SYNOPSIS
.B vlc
22
.RI [ OPTIONS ]
Christophe Massiot's avatar
Christophe Massiot committed
23
.RI [ ITEMS ]...
24 25
.SH DESCRIPTION
This manual page documents briefly the
26
.B VLC
27
multimedia player and server.
28 29 30 31 32

.SH OPTIONS
.B VLC
follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
Loïc Minier's avatar
Loïc Minier committed
33
For a precise description of options, please use "vlc \-\-help".
34 35 36 37

The complete list of
.B VLC
options depends on what plugins are installed because they automatically
Loïc Minier's avatar
Loïc Minier committed
38
add their own options. Please use "vlc \-\-longhelp \-\-advanced" for a
39
complete list of available options.
40

Christophe Massiot's avatar
Christophe Massiot committed
41
.SH ITEMS
42
.B VLC
Christophe Massiot's avatar
Christophe Massiot committed
43 44
recognizes several URL-style items:
.TP
.'s avatar
. committed
45
.B *.mpg, *.vob, *.avi, *.mp3, *.ogg, *.opus
46
Various multimedia file formats
Christophe Massiot's avatar
Christophe Massiot committed
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
Sam Hocevar's avatar
Sam Hocevar committed
50
must have been prepared beforehand.
Christophe Massiot's avatar
Christophe Massiot committed
51
.TP
52 53
.B vcd://[<device>][@{E|P|E|T|S}[<number>]]
VCD device (for instance vcd:///dev/cdrom).
Christophe Massiot's avatar
Christophe Massiot committed
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.
Christophe Massiot's avatar
Christophe Massiot committed
58
.TP
59 60 61 62 63
.B http://<server address>[:<server port>]/[<file>]
HTTP stream
.TP
.B rtsp://<server address>[:<server port>]/<stream name>
RTSP Video On Demand stream
64
.TP
65
.B vlc://<command>
66
Execute a playlist command. Commands are:
Christophe Massiot's avatar
Christophe Massiot committed
67 68 69 70
.B pause
(pause execution of other items), and
.B quit
(close VLC).
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
.SH ENVIRONMENT VARIABLES
The following environment variables may affect VLC:

.TP
.B DISPLAY
The X11 display server address.

.TP
.B http_proxy
The HTTP proxy server URL.

.TP
.B OSSAUDIO_DEV
The default audio output device,
used by the OSSv4 output plugin.

.TP
.B VLC_DATA_PATH
The directory containing VLC run-time data files (e.g. /usr/share/vlc).

.TP
.B VLC_PLUGIN_PATH
An extra directory to load VLC plugins from.

.TP
.B VLC_VERBOSE
The level of verbosity for log messages
(0: silent, 1: error/info, 2: warning, 3: debug).

.TP
.B XDG_CACHE_DIR XDG_CONFIG_DIR XDG_DATA_DIR
The directories to store user cached data, user configuration files and
user data files respectively.

.TP
.B XDG_DOCUMENTS_DIR XDG_DOWNLOAD_DIR XDG_MUSIC_DIR XDG_PICTURES_DIR XDG_VIDEO_DIR
The directories to fetch or store user text files,
downloads, music, pictures (i.e. snapshots), and video respectively.

.TP
.B XDG_SESSION_COOKIE
The unique identifier of the desktop session,
used by the PulseAudio output plugin.

116
.SH SEE ALSO
117 118
Online documentation: http://www.videolan.org/doc/
.PP
119
.SH AUTHOR
120 121
This manual page was written by Sam Hocevar <sam@zoy.org>, for the Debian
GNU/Linux system (but may be used by others).