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