X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Fvlc.1;h=45f0d0c3f9e9ecad5dacc87ef2d4b68c11d7e5dd;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=3565198da84f08349007ce2a7808e263e249b90e;hpb=501cb1ba4bfc11b6987df0cf1d27fbf91c48f495;p=vlc diff --git a/doc/vlc.1 b/doc/vlc.1 index 3565198da8..45f0d0c3f9 100644 --- a/doc/vlc.1 +++ b/doc/vlc.1 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH VLC 1 "March 10, 2001" +.TH VLC 1 "Feb 14, 2005" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -16,181 +16,62 @@ .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME -vlc, gvlc, gnome-vlc, kvlc, qvlc \- The VideoLAN Client +vlc, qvlc, svlc, nvlc, rvlc, cvlc \- the VLC media player .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. +.B VLC +multimedia player and server. + .SH OPTIONS -.B vlc +.B VLC follows the usual GNU command line syntax, with long options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-I, \-\-intf -Specify an interface module: "gnome", "curses", "qt", for instance. -.TP -.B \-v, \-\-verbose -Set -.B vlc -verbosity. This command is cumulative, you can use "-vv" or "-vvvv" for increased verbosity. -.TP -.B \-\-noaudio -Disable audio output. -.TP -.B \-A, \-\-aout -Specify an audio output module: "dsp", "esd", for instance. -.TP -.B \-\-stereo, \-\-mono -Choose stereo or mono audio output. -.TP -.B \-\-spdif -Activate hardware AC3 pass-through mode. -.TP -.B \-\-downmix -Specify a module for AC3 downmix: "downmix", "downmixsse", for instance. -.TP -.B \-\-imdct -Specify a module for AC3 IMDCT: "imdct", "imdctsse", for instance. -.TP -.B \-\-novideo -Disable video output. -.TP -.B \-V, \-\-vout -Specify a video output module: "x11", "sdl", "fb", for instance. -.TP -.B \-\-motion -Specify a module for motion compensation: "motion", "motionmmx", for instance. -.TP -.B \-\-idct -Specify a module for IDCT: "idct", "idctmmx", for instance. -.TP -.B \-\-yuv -Specify a YUV module: "yuv", "yuvmmx", for instance. -.TP -.B \-\-display -Specify the display name. -.TP -.B \-\-width , \-\-height -Choose the display coordinates. -.TP -.B \-g, \-\-grayscale -Grayscale output. -.TP -.B \-\-fullscreen -Full screen output. -.TP -.B \-\-overlay -Overlay (hardware accelerated output), if available. -.TP -.B \-\-color -Color output. -.TP -.B \-\-synchro -Choose a fixed synchro value instead of the internal auto-adaptative -heuristics based on CPU usage. +For a precise description of options, please use "vlc \-\-help". -`I' displays only I images, `IP' displays I and P images, `IP+' -displays I and P images and every second B image, and `IPB' forces -displaying of all images. +The complete list of +.B VLC +options depends on what plugins are installed because they automatically +add their own options. Please use "vlc \-\-longhelp \-\-advanced" for a +complete list of available options. -Note that vlc is not guaranteed to behave properly if you ask it to -display more images than your CPU can cope with. -.TP -.B \-t, \-\-dvdtitle -Choose the DVD title. Most movies on DVDs start on the first title, but you may want to manually select another title. -.TP -.B \-T, \-\-dvdchapter <title> -Choose the DVD chapter. DVDs are divided into titles, which in turn are divided into chapters. -.TP -.B \-a, \-\-dvdaudio [ ac3 | lpcm | mpeg | off ] -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. +.SH ITEMS +.B VLC +recognizes several URL-style items: .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 -audio channel will also depend on the channel type. +.B *.mpg, *.vob, *.avi, *.mp3, *.ogg +Various multimedia file formats .TP -.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. -.TP -.B \-\-vlans -Enable VLANs support. This feature isn't activated yet. -.TP -.B \-\-server <host>, \-\-port <port> -Choose the video server address and port. -.TP -.B \-\-broadcast -Set broadcast mode for network input. -.TP -.B \-h, \-\-help -Print help and exit. -.TP -.B \-H, \-\-longhelp -Print long help and exit. -.TP -.B \-\-version -Output version information and exit. -.SH PARAMETERS -.B vlc -also accepts a lot of parameters to customize its behaviour. +.B dvd://[<device>][@<raw device>][@[<title>][:[<chapter>][:<angle>]]] +DVD device (for instance dvd:///dev/dvd). The raw device is optional and +must have been prepared beforehand. .TP -.B Interface parameters: - vlc_intf=<method name> interface method - vlc_init=<filename> initialization script - vlc_channels=<filename> channels list +.B vcd://[<device>][@{E|P|E|T|S}[<number>]] +VCD device (for instance vcd:///dev/cdrom). .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_spdif={1|0} AC3 pass-through mode - vlc_downmix=<method name> AC3 downmix method - vlc_imdct=<method name> AC3 IMDCT method - vlc_audio_rate=<rate> output rate +.B udp://[@[<multicast address>][:<local port>]] +UDP stream, such as one sent by VLS or another VLC. +Usually "udp://" is enough. .TP -.B Video parameters: - vlc_vout=<method name> display method - vlc_display=<display> display used - vlc_width=<width> display width - vlc_height=<height> dislay height - vlc_fb_dev=<filename> framebuffer device - vlc_grayscale={1|0} grayscale or color - vlc_fullscreen={1|0} full screen - vlc_overlay={1|0} overlay - 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 +.B http://<server address>[:<server port>]/[<file>] +HTTP stream .TP -.B DVD parameters: - 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 +.B rtsp://<server address>[:<server port>]/<stream name> +RTSP Video On Demand stream .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 +.B vlc://<command> +Execute a playlist command. Commands are: +.B pause +(pause execution of other items), and +.B quit +(close VLC). .SH SEE ALSO -.BR vls (1), vlms (1) -.br +Online documentation: http://www.videolan.org/doc/ +.PP .SH AUTHOR -This manual page was written by Samuel Hocevar <sam@zoy.org>, for the Debian GNU/Linux system (but may be used by others). +This manual page was written by Sam Hocevar <sam@zoy.org>, for the Debian +GNU/Linux system (but may be used by others).