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 "March 13, 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 .SH DESCRIPTION
  25 This manual page documents briefly the
  26 .B vlc
  27 , a free MPEG2 player.
  28 .SH OPTIONS
  29 .B vlc
  30 follows the usual GNU command line syntax, with long
  31 options starting with two dashes (`-').
  32 A summary of options is included below.
  33 .TP
  34 .B \-\-noaudio
  35 Disable audio output.
  36 .TP
  37 .B \-\-aout <plugin>
  38 Specify an audio output plugin.
  39 .TP
  40 .B \-\-stereo, \-\-mono
  41 Choose stereo or mono audio output
  42 .TP
  43 .B \-\-novideo
  44 Disable video output.
  45 .TP
  46 .B \-\-vout <plugin>
  47 Specify a video output plugin.
  48 .TP
  49 .B \-\-display <display>
  50 Specify the display name.
  51 .TP
  52 .B \-\-width <w>, -\-\height <h>
  53 Choose the display coordinates.
  54 .TP
  55 .B \-g, \-\-grayscale
  56 Grayscale output.
  57 .TP
  58 .B \-\-color
  59 Color output.
  60 .TP
  61 .B \-\-novlans
  62 Disable VLANs support.
  63 .TP
  64 .B \-\-server <host>, \-\-port <port>
  65 Choose the video server address and port.
  66 .TP
  67 .B \-h, \-\-help
  68 Print help and exit.
  69 .TP
  70 .B \-H, \-\-longhelp
  71 Print long help and exit.
  72 .TP
  73 .B \-v, \-\-version
  74 Output version information and exit.
  75 .SH PARAMETERS
  76 .B vlc
  77 also accepts a lot of parameters to customize its behaviour.
  78 .TP
  79 .B Interface parameters:
  80  vlc_init=<filename>      initialization script
  81  vlc_channels=<filename>  channels list
  82 .TP
  83 .B Audio parameters:
  84  vlc_aout=<method name>   audio method
  85  vlc_dsp=<filename>       dsp device path
  86  vlc_stereo={1|0}         stereo or mono output
  87  vlc_audio_rate=<rate>    output rate
  88 .TP
  89 .B Video parameters:
  90  vlc_vout=<method name>   display method
  91  vlc_display=<display>    display used
  92  vlc_width=<width>        display width
  93  vlc_height=<height>      dislay height
  94  vlc_fb_dev=<filename>    framebuffer device path
  95  vlc_grayscale={1|0}      grayscale or color output
  96 .TP
  97 .B Input parameters:
  98  vlc_server=<hostname>    video server
  99  vlc_server_port=<port>   video server port
 100  vlc_iface=<interface>    network interface
 101  vlc_vlan_server=<host>   vlan server
 102  vlc_vlan_port=<port>     vlan server port
 103
 104 .SH SEE ALSO
 105 .BR vls (1), vlms (1)
 106 .br
 107 .SH AUTHOR
 108 This manual page was written by the VideoLAN Team <videolan@via.ecp.fr>,
 109 for the Debian GNU/Linux system (but may be used by others).