git.sesse.net Git - vlc/blob - debian/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 "August 15, 2000"
   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, fbvlc, gvlc \- The VideoLAN Client
  20 .SH SYNOPSIS
  21 .B vlc
  22 .RI [ OPTIONS ]
  23 .RI [ PARAMETERS ]
  24 .RI [ FILE ]...
  25 .SH DESCRIPTION
  26 This manual page documents briefly the
  27 .B vlc
  28 , a free MPEG2 player.
  29 .SH OPTIONS
  30 .B vlc
  31 follows the usual GNU command line syntax, with long
  32 options starting with two dashes (`-').
  33 A summary of options is included below.
  34 .TP
  35 .B \-\-noaudio
  36 Disable audio output.
  37 .TP
  38 .B \-\-aout <module>
  39 Specify an audio output module: "dsp", "esd", for instance.
  40 .TP
  41 .B \-\-stereo, \-\-mono
  42 Choose stereo or mono audio output
  43 .TP
  44 .B \-\-novideo
  45 Disable video output.
  46 .TP
  47 .B \-\-vout <module>
  48 Specify a video output module: "gnome", "fb", "glide", for instance.
  49 .TP
  50 .B \-\-motion <module>
  51 Specify a module for motion compensation: "motion", "motionmmx", for instance.
  52 .TP
  53 .B \-\-idct <module>
  54 Specify a module for IDCT: "idct", "idctmmx", for instance.
  55 .TP
  56 .B \-\-yuv <module>
  57 Specify a YUV module: "yuv", "yuvmmx", for instance.
  58 .TP
  59 .B \-\-display <display>
  60 Specify the display name.
  61 .TP
  62 .B \-\-width <w>, \-\-height <h>
  63 Choose the display coordinates.
  64 .TP
  65 .B \-g, \-\-grayscale
  66 Grayscale output.
  67 .TP
  68 .B \-\-color
  69 Color output.
  70 .TP
  71 .B \-\-synchro <type>
  72 Choose a fixed synchro value instead of the internal auto-adaptative
  73 heuristics based on CPU usage.
  74
  75 `I' displays only I images, `IP' displays I and P images, `IP+'
  76 displays I and P images and every second B image, and `IPB' forces
  77 displaying of all images.
  78
  79 Note that the vlc is certainly going to crash if you ask it to
  80 display more images than your CPU can cope with.
  81 .TP
  82 .B \-\-dvd
  83 Activate DVD mode, by directly accessing the DVD drive (no need to mount
  84 it). By default,
  85 .B vlc
  86 opens /dev/dvd, but this behaviour may be overridden by the vlc_dvd_device
  87 environment variable (see below).
  88 .TP
  89 .B \-a, \-\-dvdaudio [ ac3 | lpcm | mpeg | off ]
  90 Choose the audio channel type. Most DVDs have AC3 audio channels, but
  91 you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
  92 not to activate the audio channel.
  93 .TP
  94 .B \-c, \-\-dvdchannel [ 0\-15 ]
  95 Select the audio channel. Most DVDs only have one or two audio channels,
  96 but some of them have a great number of available languages. Note that the
  97 audio channel will also depend on the channel type.
  98 .TP
  99 .B \-s, \-\-dvdsubtitle [ 0\-31 ]
 100 Select the subtitle channel, if there is one in the stream.
 101 .TP
 102 .B \-\-novlans
 103 Disable VLANs support.
 104 .TP
 105 .B \-\-server <host>, \-\-port <port>
 106 Choose the video server address and port.
 107 .TP
 108 .B \-h, \-\-help
 109 Print help and exit.
 110 .TP
 111 .B \-H, \-\-longhelp
 112 Print long help and exit.
 113 .TP
 114 .B \-v, \-\-version
 115 Output version information and exit.
 116 .SH PARAMETERS
 117 .B vlc
 118 also accepts a lot of parameters to customize its behaviour.
 119 .TP
 120 .B Interface parameters:
 121  vlc_init=<filename>      initialization script
 122  vlc_channels=<filename>  channels list
 123  warning_level=<level>    warning level
 124 .TP
 125 .B Audio parameters:
 126  vlc_aout=<method name>   audio method
 127  vlc_dsp=<filename>       dsp device path
 128  vlc_stereo={1|0}         stereo or mono output
 129  vlc_audio_rate=<rate>    output rate
 130 .TP
 131 .B Video parameters:
 132  vlc_vout=<method name>        display method
 133  vlc_display=<display>         display used
 134  vlc_width=<width>             display width
 135  vlc_height=<height>           dislay height
 136  vlc_fb_dev=<filename>         framebuffer device
 137  vlc_grayscale={1|0}           grayscale or color
 138  vlc_idct=<method name>        IDCT method
 139  vlc_yuv=<method name>         YUV method
 140  vlc_synchro={I|I+|IP|IP+|IPB} synchro algorithm
 141 .TP
 142 .B DVD parameters:
 143  vlc_dvd_device=<device>           DVD device
 144  vlc_dvd_audio={ac3|lpcm|mpeg|off} audio type
 145  vlc_dvd_channel=[0-15]            audio channel
 146  vlc_dvd_subtitle=[0-31]           subtitle channel
 147 .TP
 148 .B Input parameters:
 149  vlc_server=<hostname>    video server
 150  vlc_server_port=<port>   video server port
 151  vlc_broadcast={1|0}      broadcast mode
 152  vlc_iface=<interface>    network interface
 153  vlc_vlan_server=<host>   vlan server
 154  vlc_vlan_port=<port>     vlan server port
 155
 156 .SH SEE ALSO
 157 .BR vls (1), vlms (1)
 158 .br
 159 .SH AUTHOR
 160 This manual page was written by the VideoLAN Team <videolan@via.ecp.fr>,
 161 for the Debian GNU/Linux system (but may be used by others).