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 "July 30, 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 \- 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 \-h, \-\-help
  85 Print help and exit.
  86 .TP
  87 .B \-H, \-\-longhelp
  88 Print long help and exit.
  89 .TP
  90 .B \-v, \-\-version
  91 Output version information and exit.
  92 .SH PARAMETERS
  93 .B vlc
  94 also accepts a lot of parameters to customize its behaviour.
  95 .TP
  96 .B Interface parameters:
  97  vlc_init=<filename>      initialization script
  98  vlc_channels=<filename>  channels list
  99 .TP
 100 .B Audio parameters:
 101  vlc_aout=<method name>   audio method
 102  vlc_dsp=<filename>       dsp device path
 103  vlc_stereo={1|0}         stereo or mono output
 104  vlc_audio_rate=<rate>    output rate
 105 .TP
 106 .B Video parameters:
 107  vlc_vout=<method name>   display method
 108  vlc_display=<display>    display used
 109  vlc_width=<width>        display width
 110  vlc_height=<height>      dislay height
 111  vlc_fb_dev=<filename>    framebuffer device path
 112  vlc_grayscale={1|0}      grayscale or color output
 113 .TP
 114 .B DVD parameters:
 115  vlc_dvd_audio={ac3|lpcm|mpeg|off} audio type
 116  vlc_dvd_channel=[0-15]            audio channel
 117  vlc_dvd_subtitle=[0-31]           subtitle channel
 118 .TP
 119 .B Input parameters:
 120  vlc_server=<hostname>    video server
 121  vlc_server_port=<port>   video server port
 122  vlc_iface=<interface>    network interface
 123  vlc_vlan_server=<host>   vlan server
 124  vlc_vlan_port=<port>     vlan server port
 125
 126 .SH SEE ALSO
 127 .BR vls (1), vlms (1)
 128 .br
 129 .SH AUTHOR
 130 This manual page was written by the VideoLAN Team <videolan@via.ecp.fr>,
 131 for the Debian GNU/Linux system (but may be used by others).