diff options
author | Darren Salt <linux@youmustbejoking.demon.co.uk> | 2008-04-09 18:28:49 +0100 |
---|---|---|
committer | Darren Salt <linux@youmustbejoking.demon.co.uk> | 2008-04-09 18:28:49 +0100 |
commit | 39939c95eff90545285a9a8f761d9fa6e9349358 (patch) | |
tree | b8ea1fa3f2ddf1627eeecbd889f47226b01a45d8 /doc | |
parent | 19357940a57c565ebe319729bd08d6e4800aff5d (diff) | |
parent | 628c4cbd9d023e74a7c6805d7ec0f163f2c172d1 (diff) | |
download | xine-lib-39939c95eff90545285a9a8f761d9fa6e9349358.tar.gz xine-lib-39939c95eff90545285a9a8f761d9fa6e9349358.tar.bz2 |
Merge from 1.2 main.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/faq/faq.docbook | 5 | ||||
-rw-r--r-- | doc/man/en/Makefile.am | 12 | ||||
-rw-r--r-- | doc/man/en/xine-config.1 | 45 | ||||
-rw-r--r-- | doc/man/en/xine-list.1.in | 40 | ||||
-rw-r--r-- | doc/man/en/xine.5 | 23 |
5 files changed, 109 insertions, 16 deletions
diff --git a/doc/faq/faq.docbook b/doc/faq/faq.docbook index 8d09441e1..acbb4c016 100644 --- a/doc/faq/faq.docbook +++ b/doc/faq/faq.docbook @@ -2223,7 +2223,7 @@ OK, yes, that shouldn't happen and you're upset. We can understand that. But, to help you and of course to fix this, we need some information. So, let's go through the checklist and maybe prepare a nice bug report - for the xine-user mailing list: + for the <ulink url="http://bugs.xine-project.org/">xine bug tracker</ulink>: <itemizedlist> <listitem> <para> @@ -2269,8 +2269,7 @@ still under heavy development (nice excuse, isn't it? *grin*). </para> <para> - If you write to the xine user mailing list - <email>xine-user@lists.sourceforge.net</email> + If you write to the <ulink url="http://bugs.xine-project.org/">xine bug tracker</ulink> make sure you include a the above information (when applicable) and also some information about your machine (operating system, cpu type and speed, gfx card, sound card, ...) and please use a meaningfull subject diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am index ee0296033..9fe87cc11 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 + (echo '.ds xl xine\-list\-@XINE_SERIES@'; cat $<) >$@ diff --git a/doc/man/en/xine-config.1 b/doc/man/en/xine-config.1 index c43e3890a..034cd405c 100644 --- a/doc/man/en/xine-config.1 +++ b/doc/man/en/xine-config.1 @@ -1,9 +1,16 @@ +.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 is DEPRECATED. Use pkg\-config instead.\fP @@ -14,19 +21,37 @@ and link programs that use \fIlibxine\fP. It can also be used to determine the directories where \fIlibxine\fP expects plugins. .SH OPTIONS .l -\fIxine-config\fP accepts the following options, passing them on (possibly -modified) to \fIpkg-config libxine\fP: +\fIxine\-config\fP accepts the following options, passing them on (possibly +modified) to \fIpkg\-config libxine\fP: .TP 8 .B \-\-version \-\-modversion +.br +Print the currently installed version of \fIlibxine\fP on the standard output. .TP 8 -.B \-\-libs \fP&\fB \-\-cflags +.B \-\-libs +.TQ 8 +.B \-\-cflags +.TQ 8 +.B \-\-objcflags Passed on unmodified. +.br +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 -\-\-variable=plugindir +.TQ 8 +.B \-\-datadir +.TQ 8 +.B \-\-scriptdir +.TQ 8 +.B \-\-localedir +\-\-variable=... .br -Print the directory where \fIlibxine\fP plugins are stored/expected. +Print the directory where, respectively, \fIlibxine\fP binaries, plugins, +data files, scripts and locale data are stored/expected. .TP 8 .B \-\-prefix=PREFIX \-\-define\-variable=prefix=PREFIX @@ -45,8 +70,8 @@ If specified, use PREFIX instead of the installation exec prefix that .BR xine-lib (3), .BR xine (1) .SH COPYRIGHT -Copyright \(co 2001 Siggi Langauf, \(co 2001-2007 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..e159852c8 --- /dev/null +++ b/doc/man/en/xine-list.1.in @@ -0,0 +1,40 @@ +.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 +.l +\fIxine\-list\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 2c267f5d3..3d3975ec4 100644 --- a/doc/man/en/xine.5 +++ b/doc/man/en/xine.5 @@ -257,6 +257,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 @@ -266,7 +283,7 @@ Text subtitle files may be appended to the MRL:. This is the normal way to define the subtitle file to use. The frontend will not take any notice of the subtitle file. For example: .br -.I file://home/user/wibble.mpg#subtitles:/home/user/wibble.sub +.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.) @@ -296,6 +313,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 |