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 <plugin>
  39 Specify an audio output plugin: "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 <plugin>
  48 Specify a video output plugin: "gnome", "fb", "glide", for instance.
  49 .TP
  50 .B \-\-yuv <plugin>
  51 Specify a YUV plugin: "mmx", "nommx", for instance.
  52 .TP
  53 .B \-\-display <display>
  54 Specify the display name.
  55 .TP
  56 .B \-\-width <w>, \-\-height <h>
  57 Choose the display coordinates.
  58 .TP
  59 .B \-g, \-\-grayscale
  60 Grayscale output.
  61 .TP
  62 .B \-\-color
  63 Color output.
  64 .TP
  65 .B \-a, \-\-dvdaudio [ ac3 | lpcm | mpeg | off ]
  66 Choose the audio channel type. Most DVDs have AC3 audio channels, but
  67 you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
  68 not to activate the audio channel.
  69 .TP
  70 .B \-c, \-\-dvdchannel [ 0\-15 ]
  71 Select the audio channel. Most DVDs only have one or two audio channels,
  72 but some of them have a great number of available languages. Note that the
  73 audio channel will also depend on the channel type.
  74 .TP
  75 .B \-s, \-\-dvdsubtitle [ 0\-31 ]
  76 Select the subtitle channel, if there is one in the stream.
  77 .TP
  78 .B \-\-novlans
  79 Disable VLANs support.
  80 .TP
  81 .B \-\-server <host>, \-\-port <port>
  82 Choose the video server address and port.
  83 .TP
  84 .B \-\-synchro <type>
  85 Choose a fixed synchro value instead of the internal auto-adaptative
  86 heuristics based on CPU usage.
  87
  88 `I' displays only I images, `IP' displays I and P images, `IP+'
  89 displays I and P images and every second B image, and `IPB' forces
  90 displaying of all images.
  91
  92 Note that the vlc is certainly going to crash if you ask it to
  93 display more images than your CPU can cope with.
  94 .TP
  95 .B \-h, \-\-help
  96 Print help and exit.
  97 .TP
  98 .B \-H, \-\-longhelp
  99 Print long help and exit.
 100 .TP
 101 .B \-v, \-\-version
 102 Output version information and exit.
 103 .SH PARAMETERS
 104 .B vlc
 105 also accepts a lot of parameters to customize its behaviour.
 106 .TP
 107 .B Interface parameters:
 108  vlc_init=<filename>      initialization script
 109  vlc_channels=<filename>  channels list
 110 .TP
 111 .B Audio parameters:
 112  vlc_aout=<method name>   audio method
 113  vlc_dsp=<filename>       dsp device path
 114  vlc_stereo={1|0}         stereo or mono output
 115  vlc_audio_rate=<rate>    output rate
 116 .TP
 117 .B Video parameters:
 118  vlc_vout=<method name>   display method
 119  vlc_display=<display>    display used
 120  vlc_width=<width>        display width
 121  vlc_height=<height>      dislay height
 122  vlc_fb_dev=<filename>    framebuffer device path
 123  vlc_grayscale={1|0}      grayscale or color output
 124 .TP
 125 .B DVD parameters:
 126  vlc_dvd_audio={ac3|lpcm|mpeg|off} audio type
 127  vlc_dvd_channel=[0-15]            audio channel
 128  vlc_dvd_subtitle=[0-31]           subtitle channel
 129 .TP
 130 .B Input parameters:
 131  vlc_server=<hostname>    video server
 132  vlc_server_port=<port>   video server port
 133  vlc_iface=<interface>    network interface
 134  vlc_vlan_server=<host>   vlan server
 135  vlc_vlan_port=<port>     vlan server port
 136 .TP
 137 .B Synchro parameters:
 138  vlc_synchro=<type>       synchro algorithm
 139
 140 .SH SEE ALSO
 141 .BR vls (1), vlms (1)
 142 .br
 143 .SH AUTHOR
 144 This manual page was written by the VideoLAN Team <videolan@via.ecp.fr>,
 145 for the Debian GNU/Linux system (but may be used by others).