]> git.sesse.net Git - vlc/blobdiff - doc/vlc.1
* ./include/modules_inner.h: replaced _X with __VLC_SYMBOL because _X was
[vlc] / doc / vlc.1
index a4080c7038b73a80f19d99483bd724796a8abb91..3aa66b65bac9716ac415a456ec7385ef7dd8f849 100644 (file)
--- a/doc/vlc.1
+++ b/doc/vlc.1
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7)
 .SH NAME
-vlc, gvlc, kvlc, qvlc \- The VideoLAN Client
+vlc, gvlc, gnome-vlc, qvlc \- The VideoLAN Client
 .SH SYNOPSIS
 .B vlc
 .RI [ OPTIONS ]
 .RI [ PARAMETERS ]
-.RI [ FILE ]...
+.RI [ ITEMS ]...
 .SH DESCRIPTION
 This manual page documents briefly the
 .B vlc
 , a free MPEG, MPEG2 and DVD player.
+.SH ITEMS
+.B vlc
+recognizes several URL-style items:
+.TP
+.B *.mpg, *.vob
+Plain MPEG-1/2 files
+.TP
+.B dvd:<device>[@<raw device>]
+DVD device (for instance dvd:/dev/dvd). The raw device is optional and
+must have been prepared beforehands.
+.TP
+.B vcd:<device>
+VCD device (for instance dvd:/dev/cdrom).
+.TP
+.B udpstream:[<server>[:<server port>]][@[<bind address>][:<bind port>]]
+UDP stream, such as one sent by VideoLAN Server or VideoLAN miniserver.
+Usually "udpstream:" is enough.
+.TP
+.B vlc:<command>
+Execute a play-list command. Commands are :
+.B loop
+(loop the playlist),
+.B pause
+(pause execution of other items), and
+.B quit
+(close VLC).
 .SH OPTIONS
 .B vlc
 follows the usual GNU command line syntax, with long
@@ -40,6 +66,9 @@ Set
 .B vlc
 verbosity. This command is cumulative, you can use "-vv" or "-vvvv" for increased verbosity.
 .TP
+.B \-\-memcpy <module>
+Specify a module for performing heavy memory copies: "memcpy", "sse" for instance.
+.TP
 .B \-\-noaudio
 Disable audio output.
 .TP
@@ -47,7 +76,22 @@ Disable audio output.
 Specify an audio output module: "dsp", "esd", for instance.
 .TP
 .B \-\-stereo, \-\-mono
-Choose stereo or mono audio output
+Choose stereo or mono audio output.
+.TP
+.B \-\-spdif
+Activate hardware AC3 pass-through mode.
+.TP
+.B \-\-downmix <module>
+Specify a module for AC3 downmix: "downmix", "sse" or "3dn" for instance.
+.TP
+.B \-\-imdct <module>
+Specify a module for AC3 IMDCT: "imdct", sse" or "3dn"  for instance.
+.TP
+.B \-\-volume [1..1024]
+Change VLC output volume (default: 512).
+.TP
+.B \-\-desync <time in ms>
+Compensate desynchronization of the audio (default: 0).
 .TP
 .B \-\-novideo
 Disable video output.
@@ -79,6 +123,9 @@ Full screen output.
 .B \-\-overlay
 Overlay (hardware accelerated output), if available.
 .TP
+.B \-\-xvadaptor <port>
+Select XVideo adaptor, if XVideo output is used.
+.TP
 .B \-\-color
 Color output.
 .TP
@@ -104,6 +151,9 @@ Choose the audio channel type. Most DVDs have AC3 audio channels, but
 you can also have Linear PCM or MPEG layer 2 sound. Also, one might decide
 not to activate the audio channel.
 .TP
+.B \-u, \-\-dvdangle <num>
+Choose the angle, available on some DVDs.
+.TP
 .B \-c, \-\-dvdchannel [ 0\-15 ]
 Select the audio channel. Most DVDs only have one or two audio channels,
 but some of them have a great number of available languages. Note that the
@@ -112,17 +162,19 @@ audio channel will also depend on the channel type.
 .B \-s, \-\-dvdsubtitle [ 0\-31 ]
 Select the subtitle channel, if there is one in the stream.
 .TP
-.B \-\-input <method>
-Choose the input method, "dvd", "ps", "ts" for instance.
+.B \-\-dvdcss-method <method>
+Select the CSS decryption scheme when using libdvdcss. Usually to choose
+from "disc", "title" or "key", but depends on your libdvdcss version.
 .TP
-.B \-\-vlans
-Enable VLANs support. This feature isn't activated yet.
+.B \-\-dvdcss-verbose <level>
+Select the CSS decryption verbosity level, 0, 1 or 2.
 .TP
-.B \-\-server <host>, \-\-port <port>
-Choose the video server address and port.
+.B \-\-input <method>
+Choose the input method, "dvd", "ps", "ts" for instance.
 .TP
-.B \-\-broadcast
-Set broadcast mode for network input.
+.B \-\-nommx, \-\-no3dnow, \-\-nommxext, \-\-nosse, \-\-noaltivec
+Disable the CPU's MMX, 3D Now!, MMX EXT, SSE or AltiVec support. This may
+be useful when you suspect a bug in an accelerated module.
 .TP
 .B \-h, \-\-help
 Print help and exit.
@@ -130,7 +182,7 @@ Print help and exit.
 .B \-H, \-\-longhelp
 Print long help and exit.
 .TP
-.B \-v, \-\-version
+.B \-\-version
 Output version information and exit.
 .SH PARAMETERS
 .B vlc
@@ -138,14 +190,16 @@ also accepts a lot of parameters to customize its behaviour.
 .TP
 .B Interface parameters:
  vlc_intf=<method name>   interface method
- vlc_init=<filename>      initialization script
- vlc_channels=<filename>  channels list
 .TP
 .B Audio parameters:
- vlc_aout=<method name>   audio method
- vlc_dsp=<filename>       dsp device path
- vlc_stereo={1|0}         stereo or mono output
- vlc_audio_rate=<rate>    output rate
+ vlc_aout=<method name>        audio method
+ vlc_dsp=<filename>            dsp device path
+ vlc_stereo={1|0}              stereo or mono output
+ vlc_spdif={1|0}               AC3 pass-through mode
+ vlc_downmix=<method name>      AC3 downmix method
+ vlc_imdct=<method name>        AC3 IMDCT method
+ vlc_volume=[0..1024]          VLC output volume
+ vlc_audio_rate=<rate>         output rate
 .TP
 .B Video parameters:
  vlc_vout=<method name>        display method
@@ -156,6 +210,8 @@ also accepts a lot of parameters to customize its behaviour.
  vlc_grayscale={1|0}           grayscale or color
  vlc_fullscreen={1|0}          full screen
  vlc_overlay={1|0}             overlay
+ vlc_xvport=<port>             XVideo port
+ vlc_motion=<method name>      motion compensation method
  vlc_idct=<method name>        IDCT method
  vlc_yuv=<method name>         YUV method
  vlc_synchro={I|I+|IP|IP+|IPB} synchro algorithm
@@ -164,17 +220,13 @@ also accepts a lot of parameters to customize its behaviour.
  vlc_dvd_device=<device>           DVD device
  vlc_input_title=<title>           title number
  vlc_input_chapter=<chapter>       chapter number
- vlc_audio={ac3|lpcm|mpeg|off}     audio type
- vlc_channel=[0-15]                audio channel
- vlc_subtitle=[0-31]               subtitle channel
+ vlc_input_angle=<angle>           angle number
+ vlc_input_audio={ac3|lpcm|mpeg|off} audio type
+ vlc_input_channel=[0-15]          audio channel
+ vlc_input_subtitle=[0-31]         subtitle channel
 .TP
 .B Input parameters:
- vlc_server=<hostname>    video server
- vlc_server_port=<port>   video server port
- vlc_broadcast={1|0}      broadcast mode
  vlc_iface=<interface>    network interface
- vlc_vlan_server=<host>   vlan server
- vlc_vlan_port=<port>     vlan server port
 
 .SH SEE ALSO
 .BR vls (1), vlms (1)