diff options
Diffstat (limited to 'doc/man/en')
-rw-r--r-- | doc/man/en/Makefile.am | 12 | ||||
-rw-r--r-- | doc/man/en/xine-config.1 | 42 | ||||
-rw-r--r-- | doc/man/en/xine-list.1.in | 39 | ||||
-rw-r--r-- | doc/man/en/xine.5 | 87 |
4 files changed, 140 insertions, 40 deletions
diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am index ee0296033..c8d616c35 100644 --- a/doc/man/en/Makefile.am +++ b/doc/man/en/Makefile.am @@ -1,5 +1,13 @@ include $(top_srcdir)/misc/Makefile.common -man_MANS = xine-config.1 xine.5 +STATICMANS = xine-config.1 xine.5 +DYNAMICMANS = xine-list-@XINE_SERIES@.1 -EXTRA_DIST = $(man_MANS) +man_MANS = $(STATICMANS) $(DYNAMICMANS) + +BUILT_SOURCES = $(DYNAMICMANS) +DISTCLEANFILES = $(DYNAMICMANS) +EXTRA_DIST = $(STATICMANS) xine-list.1.in + +xine-list-@XINE_SERIES@.1: xine-list.1.in + $(SED) -e 's/@XL@/xine\-list\-@XINE_SERIES@/' $< >$@ diff --git a/doc/man/en/xine-config.1 b/doc/man/en/xine-config.1 index 0a2d8bcc6..3fe828166 100644 --- a/doc/man/en/xine-config.1 +++ b/doc/man/en/xine-config.1 @@ -1,12 +1,19 @@ +.de TQ +.br +.ns +.TP \\$1 +.. .TH XINE 1 2001-08-28 "The xine project" .SH NAME -xine-config - script to get information about the installed version of libxine +xine\-config - script to get information about the installed version of libxine .SH SYNOPSIS -.B xine-config -[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cflags] [\-\-plugindir] [\-\-skindir] +.B xine\-config +[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version] +[\-\-libs] [\-\-cflags] [\-\-objcflags] +[\-\-plugindir] [\-\-datadir] [\-\-scriptdir] [\-\-localedir] .SH DESCRIPTION .PP -\fIxine-config\fP is a tool that is used to determine +\fIxine\-config\fP is a tool that is used to determine the compiler and linker flags that should be used to compile and link programs that use \fIlibxine\fP. It can also be used to determine the directories where \fIlibxine\fP expects plugins and skins. @@ -14,8 +21,7 @@ Finally, it's also used internally by the .m4 macros for GNU autoconf that are included with \fIxine-lib\fP. . .SH OPTIONS -.l -\fIxine-config\fP accepts the following options: +\fIxine\-config\fP accepts the following options: .TP 8 .B \-\-version Print the currently installed version of \fIlibxine\fP on the standard output. @@ -24,14 +30,22 @@ Print the currently installed version of \fIlibxine\fP on the standard output. Print the linker flags that are necessary to link \fIlibxine\fP to a program. .TP 8 .B \-\-cflags -Print the compiler flags that are necessary to compile a program that uses -\fIlibxine\fP. +.TQ 8 +.B \-\-objcflags +Print the compiler flags (for C and Objective C, respectively) that are +necessary to compile a program that uses \fIlibxine\fP. .TP 8 +.B \-\-bindir +.TQ 8 .B \-\-plugindir -Print the directory where \fIlibxine\fP plugins are stored/expected. -.TP 8 -.B \-\-skindir -Print the directory in which \fIlibxine\fP skins are stored/expected. +.TQ 8 +.B \-\-datadir +.TQ 8 +.B \-\-scriptdir +.TQ 8 +.B \-\-localedir +Print the directory where, respectively, \fIlibxine\fP binaries, plugins, +data files, scripts and locale data are stored/expected. .TP 8 .B \-\-prefix=PREFIX If specified, use PREFIX instead of the installation prefix that \fIxine-lib\fP @@ -49,8 +63,8 @@ and \-\-libs options. This option must be specified before any .BR xine-lib (3), .BR xine (1) .SH COPYRIGHT -Copyright \(co 2001 Siggi Langauf/the xine project, based on the man page -for gtk-config, \(co 1998 Owen Taylor +Copyright \(co 2001 Siggi Langauf, \(co 2001-2008 the xine project. +Based on the man page for gtk-config, \(co 1998 Owen Taylor. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, diff --git a/doc/man/en/xine-list.1.in b/doc/man/en/xine-list.1.in new file mode 100644 index 000000000..558b44df0 --- /dev/null +++ b/doc/man/en/xine-list.1.in @@ -0,0 +1,39 @@ +.TH XINE 1 2001-08-28 "The xine project" +.SH NAME +@XL@ - get supported filetype information from xine-lib +.SH SYNOPSIS +.B @XL@ +[\fPoptions...\fI] +.SH DESCRIPTION +.PP +\fI@XL@\fP is a tool that is used to list the MIME type and filename +extension information known and supported by the installed \fIxine-lib\fP. +It is of use in filling in MIME information in front ends' desktop files. +. +.SH OPTIONS +\fI@XL@\fP accepts the following options: +.TP 8 +.B \-m +.B \-\-mime\-types +List the MIME types known to \fIxine-lib\fP. (This is the default action.) +.TP 8 +.B \-e +.B \-\-extensions +List the file types (filename extensions) known to \fIxine-lib\fP. +.TP 8 +.B \-a +.B \-\-all +List the MIME types known to \fIxine-lib\fP, along with their filename +extensions and descriptions. +.TP 8 +.B \-p +.B \-\-pretty\-print +Add line feeds; print each item on a line of its own. +.SH COPYRIGHT +Copyright \(co 2008 the xine project. + +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose and without fee is hereby granted, provided +that the above copyright notice appear in all copies and that both that +copyright notice and this permission notice appear in supporting +documentation. diff --git a/doc/man/en/xine.5 b/doc/man/en/xine.5 index 7a9357640..195fb1596 100644 --- a/doc/man/en/xine.5 +++ b/doc/man/en/xine.5 @@ -32,60 +32,73 @@ to read from. Valid MRLs may be plain file names or one of the following .TP \(bu CD and DVD: .br -.BI dvd:/[<device_name>][/<title>.<part>] +.BI dvd:/[ device_name ][/ title [. part ]] .br -.BI dvd:/<DVD_image_file_or_directory>[/<title>.<part>] +.BI dvd:/ DVD_image_file [/ title [. part ]] .br -.BI vcd://[<CD_image>|<device_name>][@[letter]<number>] +.BI dvd:/ DVD_directory [/ title [. part ]] .br -.BI vcdo://<track_number> + (use the path of the directory which contains VIDEO_TS) .br -.BI cdda:/[<device>][/<track-number>] +.BI vcd://[ CD_image_or_device_name ][@[ letter ] number ] +.br +.BI vcdo:// track_number +.br +.BI cdda:/[ device ][/ track_number ] .LP .TP \(bu Video devices: .br -.BI v4l://[<tuner_device>/<frequency>] +.BI v4l://[ tuner_device / frequency ] +.br +.BI dvb:// channel_number +.br + (nth channel in your channels.conf) +.br +.BI dvb:// channel_name .br -.BI dvb://<number_or_channel_name> +.BI dvbc:// channel_name : tuning_parameters .br -.BI dvbc://<channel_name>:<tuning_parameters> +.BI dvbs:// channel_name : tuning_parameters .br -.BI dvbs://<channel_name>:<tuning_parameters> +.BI dvbt:// channel_name : tuning_parameters .br -.BI dvbt://<channel_name>:<tuning_parameters> +.BI dvba:// channel_name : tuning_parameters .br -.BI dvba://<channel_name>:<tuning_parameters> +.BI pvr:/ tmp_files_path ! saved_files_path ! max_page_age .br -.BR pvr:/<tmp_files_path>!<saved_files_path>!<max_page_age> " (for WinTV PVR 250 and 350)" + (for WinTV PVR 250 and 350) .LP .TP \(bu Network: .br -.BI http://<host>... +.BI http:// host... .br -.BR tcp://<host>[:<port>] " (default port is 7658)" +.BI tcp:// host [: port ] .br -.BR udp://<host>[:<port>[?iface=<interface>]] " (default port is 7658)" +.BI udp:// host [: port [?iface= interface ]] .br -.BR rtp://<host>[:<port>[?iface=<interface>]] " (default port is 7658)" +.BI rtp:// host [: port [?iface= interface ]] +.br + (default port for tcp, udp and rtp is 7658) .br .BI smb://... .br -.BI mms://<host>... +.BI mms:// host... .br -.BI pnm://<host>... +.BI pnm:// host... .br -.BR rtsp://<host>... " (requires Real codecs)" +.BI rtsp:// host... "\fR (requires Real codecs)" .br .LP Additional input plugins will provide additional MRL types. The ones listed above are available with stock libxine. \fBNOTE:\fP where a file name is required, the \fIfull path must be -provided\fP - from a shell, you can use \fB"$PWD/file"\fP or +provided\fP - from a shell, you can normally use \fB"$PWD/file"\fP or \fB"$(pwd)/file"\fP or \fB"\`pwd\`/file"\fP if the file is in the current -directory. (Which one depends on your shell; all three work in bash.) +directory. (Which one depends on your shell; all three work in bash. Also, +normal URL encoding rules apply; `%', in particular, must be encoded as `%25'.) As of xine-lib 1.1.3, the DVD title number may be 0 (select navigation) and the chapter number may be 0 (full title). @@ -256,6 +269,23 @@ audio program ID .TP 20 .B service-id service ID (needed for now/next information etc.) +.PP +The following keyboard & mouse inputs may be accepted: +.TP 24 +.B Menu 2 +Start/stop recording +.TP 24 +.B Menu 3 +Toggle zoom +.TP 24 +.B Menu 7 +Toggle now/next display +.TP 24 +.B Previous/Next Chapter +Previous/next channel +.TP 24 +.B Mouse wheel & button 1 +Scroll through channel list & select the highlighted channel .SH SUBTITLE .B external subtitle files (any mrl) .br @@ -263,7 +293,12 @@ Text subtitle files may be appended to the MRL:. .TP .BI <mrl>#subtitle:<subtitlefile> This is the normal way to define the subtitle file to use. The frontend will -not take any notice of the subtitle file. +not take any notice of the subtitle file. For example: +.br +.I file://home/user/wibble.mpg#subtitle:/home/user/wibble.sub +.br +(Note that some front ends can detect subtitles files where the name differs +as shown in the example.) .br .SH STREAM OPTIONS .br @@ -290,6 +325,10 @@ Set audio dynamic range compression. .BI <config\ entry> : <config\ value> Assign a new value to any config entry. .TP +.BI save: <file> +Save the stream (if allowed) to the named file, relative to the directory +given by the option "media.capture.save_dir". +.TP .B change configuration option 'on the fly': .br You can change a configuration option at any time, using the special @@ -307,8 +346,8 @@ stream. .br The programs are documented fully on the xine home page: -.UR http://xinehq.de/ -.IR "http://xinehq.de/" +.UR http://www.xine-project.org/ +.IR "http://www.xine-project.org/" .UE .SH AUTHOR This text was extracted from the xine man page by Darren Salt |