vlc.1 4.63 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
.\"                                      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)
.TH VLC 1 "August 15, 2000"
.\" 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
vlc, fbvlc, gvlc \- The VideoLAN Client
.SH SYNOPSIS
.B vlc
Sam Hocevar's avatar
 
Sam Hocevar committed
22
.RI [ OPTIONS ]
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
.RI [ PARAMETERS ]
.RI [ FILE ]...
.SH DESCRIPTION
This manual page documents briefly the
.B vlc
, a free MPEG2 player.
.SH OPTIONS
.B vlc
follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
.B \-\-noaudio
Disable audio output.
.TP
Sam Hocevar's avatar
 
Sam Hocevar committed
38 39
.B \-\-aout <module>
Specify an audio output module: "dsp", "esd", for instance.
40 41 42 43 44 45 46
.TP
.B \-\-stereo, \-\-mono
Choose stereo or mono audio output
.TP
.B \-\-novideo
Disable video output.
.TP
Sam Hocevar's avatar
 
Sam Hocevar committed
47 48
.B \-\-vout <module>
Specify a video output module: "gnome", "fb", "glide", for instance.
49
.TP
Sam Hocevar's avatar
 
Sam Hocevar committed
50 51 52 53 54
.B \-\-idct <module>
Specify a module for IDCT: "idct", "idctmmx", for instance.
.TP
.B \-\-yuv <module>
Specify a YUV module: "yuv", "yuvmmx", for instance.
55 56 57 58 59 60 61 62 63 64 65 66 67
.TP
.B \-\-display <display>
Specify the display name.
.TP
.B \-\-width <w>, \-\-height <h>
Choose the display coordinates.
.TP
.B \-g, \-\-grayscale
Grayscale output.
.TP
.B \-\-color
Color output.
.TP
Sam Hocevar's avatar
 
Sam Hocevar committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
.B \-\-synchro <type>
Choose a fixed synchro value instead of the internal auto-adaptative
heuristics based on CPU usage.

`I' displays only I images, `IP' displays I and P images, `IP+'
displays I and P images and every second B image, and `IPB' forces
displaying of all images.

Note that the vlc is certainly going to crash if you ask it to
display more images than your CPU can cope with.
.TP
.B \-\-dvd
Activate DVD mode, by directly accessing the DVD drive (no need to mount
it). By default,
.B vlc
opens /dev/dvd, but this behaviour may be overridden by the vlc_dvd_device
environment variable (see below).
.TP
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 116 117 118 119
.B \-a, \-\-dvdaudio [ ac3 | lpcm | mpeg | off ]
Choose the audio channel type. Most DVDs have AC3 audio channels, but
you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
not to activate the audio channel.
.TP
.B \-c, \-\-dvdchannel [ 0\-15 ]
Select the audio channel. Most DVDs only have one or two audio channels,
but some of them have a great number of available languages. Note that the
audio channel will also depend on the channel type.
.TP
.B \-s, \-\-dvdsubtitle [ 0\-31 ]
Select the subtitle channel, if there is one in the stream.
.TP
.B \-\-novlans
Disable VLANs support.
.TP
.B \-\-server <host>, \-\-port <port>
Choose the video server address and port.
.TP
.B \-h, \-\-help
Print help and exit.
.TP
.B \-H, \-\-longhelp
Print long help and exit.
.TP
.B \-v, \-\-version
Output version information and exit.
.SH PARAMETERS
.B vlc
also accepts a lot of parameters to customize its behaviour.
.TP
.B Interface parameters:
 vlc_init=<filename>      initialization script
 vlc_channels=<filename>  channels list
Sam Hocevar's avatar
 
Sam Hocevar committed
120
 warning_level=<level>    warning level
121 122 123 124 125 126 127 128
.TP
.B Audio parameters:
 vlc_aout=<method name>   audio method
 vlc_dsp=<filename>       dsp device path
 vlc_stereo={1|0}         stereo or mono output
 vlc_audio_rate=<rate>    output rate
.TP
.B Video parameters:
Sam Hocevar's avatar
 
Sam Hocevar committed
129 130 131 132 133 134 135 136 137
 vlc_vout=<method name>        display method
 vlc_display=<display>         display used
 vlc_width=<width>             display width
 vlc_height=<height>           dislay height
 vlc_fb_dev=<filename>         framebuffer device
 vlc_grayscale={1|0}           grayscale or color
 vlc_idct=<method name>        IDCT method
 vlc_yuv=<method name>         YUV method
 vlc_synchro={I|I+|IP|IP+|IPB} synchro algorithm
138 139
.TP
.B DVD parameters:
Sam Hocevar's avatar
 
Sam Hocevar committed
140
 vlc_dvd_device=<device>           DVD device
141 142 143 144 145 146 147
 vlc_dvd_audio={ac3|lpcm|mpeg|off} audio type
 vlc_dvd_channel=[0-15]            audio channel
 vlc_dvd_subtitle=[0-31]           subtitle channel
.TP
.B Input parameters:
 vlc_server=<hostname>    video server
 vlc_server_port=<port>   video server port
Sam Hocevar's avatar
 
Sam Hocevar committed
148
 vlc_broadcast={1|0}      broadcast mode
149 150 151 152 153 154 155 156 157 158
 vlc_iface=<interface>    network interface
 vlc_vlan_server=<host>   vlan server
 vlc_vlan_port=<port>     vlan server port

.SH SEE ALSO
.BR vls (1), vlms (1)
.br
.SH AUTHOR
This manual page was written by the VideoLAN Team <videolan@via.ecp.fr>,
for the Debian GNU/Linux system (but may be used by others).