From 883b65b8005a32e2f333e92523afd6dd396d7dc2 Mon Sep 17 00:00:00 2001 From: Jens Georg Date: Wed, 18 Aug 2010 18:39:05 +0300 Subject: [PATCH] [doc] Add manpages for rygel and rygel.conf --- Makefile.am | 2 +- configure.ac | 5 + doc/Makefile.am | 14 ++ doc/man/rygel.conf.xml | 335 +++++++++++++++++++++++++++++++++++++++++ doc/man/rygel.xml | 396 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 751 insertions(+), 1 deletion(-) create mode 100644 doc/Makefile.am create mode 100644 doc/man/rygel.conf.xml create mode 100644 doc/man/rygel.xml diff --git a/Makefile.am b/Makefile.am index cd3c054..257de75 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = src data tests po +SUBDIRS = src data tests po doc pkgconfig_DATA= rygel-1.0.pc pkgconfigdir = $(libdir)/pkgconfig diff --git a/configure.ac b/configure.ac index 5fe236d..f29e7cb 100644 --- a/configure.ac +++ b/configure.ac @@ -263,6 +263,10 @@ AC_SUBST(VALAFLAGS) dnl Shave the output AM_SILENT_RULES([yes]) +dnl documenation +AC_PATH_PROG([XSLTPROC], [xsltproc]) +AM_CONDITIONAL([HAVE_XSLTPROC], [test x"$XSLTPROC" != x]) + AC_OUTPUT([ Makefile src/Makefile @@ -283,6 +287,7 @@ data/icons/32x32/Makefile data/icons/48x48/Makefile data/icons/120x120/Makefile data/icons/scalable/Makefile +doc/Makefile po/Makefile.in rygel-1.0.pc tests/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..3a5274e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,14 @@ +dist_man_MANS = \ + rygel.1 \ + rygel.conf.5 + +EXTRA_DIST = \ + man/rygel.xml \ + man/rygel.conf.xml + +if HAVE_XSLTPROC +%.5 %.1: man/%.xml + $(XSLTPROC) -o $@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< +CLEANFILES = \ + $(dist_man_MANS) +endif diff --git a/doc/man/rygel.conf.xml b/doc/man/rygel.conf.xml new file mode 100644 index 0000000..43364d3 --- /dev/null +++ b/doc/man/rygel.conf.xml @@ -0,0 +1,335 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A typical entry +in a Makefile or Makefile.am is: + +DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl +XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" + +manpage.1: manpage.xml + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The XSL files are in +docbook-xsl. A description of the parameters you can use can be found in the +docbook-xsl-doc-* packages. Please remember that if you create the nroff +version in one of the debian/rules file targets (such as build), you will need +to include xsltproc and docbook-xsl in your Build-Depends control field. +Alternatively use the xmlto command/package. That will also automatically +pull in xsltproc and docbook-xsl. + +Notes for using docbook2x: docbook2x-man does not automatically create the +AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as + ... . + +To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections +read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be +found in the docbook-xsl-doc-html package. + +Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` + +General documentation about man-pages and man-page-formatting: +man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + +--> + + + + + + + + + + + + + +]> + + + &dhtitle; + &dhpackage; + + + &dhfirstname; + &dhsurname; + Wrote this manpage. +
+ &dhemail; +
+ + + + + &dhucpackage; + &dhsection; + + + &dhucpackage; + Rygel configuration file + + + + $XDG_CONFIG_DIR/rygel.conf + + + /etc/rygel.conf + + + + DESCRIPTION + &dhpackage; reads its configuration values from the file $XDG_CONFIG_DIR/rygel.conf or - if that file does not exist - from the file /etc/rygel.conf. + Most of the options may be overriden by commandline arguments or envronment variables. See + rygel + 1 + for details on those. + + + GENERAL DIRECTIVES + Lists in the configuration files are separated by a semicolon (;). Boolean values may be either true or false. + + + + + + + Set the network-interface rygel listens on. + + + + + + + + Set the listen-port. + + + + + + + + Set to true to enable transcoding in general. + + + + + + + + Set to true to enable transcoding to MP3. + + + + + + + + Set to true to enable transcoding to MPEG2 in TS container. + + + + + + + + Set to true to enable transcoding to Linear PCM. + + + + + + + + Set to true to enable transcoding to WMV. + + + + + + + + Set the log level. 1=critical, 2=error, 3=warning, 4=message/info, 5=debug + + + + + + + + Set the plugin search path + + + + Plugin-specific sections are denoted with and can contain plugin-specific options as well as common options: + + + =TITLE + + Title of the device implemented by this plugin. There are some variables which will be replaced by &dhpackage;. @REALNAME@ will be subsituted by the user's real name, @USERNAME@ by the user's login id and @HOSTNAME@ by the name of the machine &dhpackage;runs on. + + + + + + + + You can individually enable or disable plugins by setting this to or . + + + + + + Tracker Plugin + The tracker plugin uses the centralized database of meta information from the tracker project. See http://www.tracker-project.org for more information about tracker. + + + + + + + Enable or disable sharing of all pictures in the Tracker database. + + + + + + + + Enable or disable sharing of all videos in the Tracker database. + + + + + + + + Enable or disable sharing of all music in the Tracker database. + + + + + + MediaExport Plugin + MediaExport is an alternative to the Tracker-backed media export. MediaExport extracts meta-data by itself and stores it in the SQLite database in $XDG_CACHE_DIR/rygel/media-export.db on UNIX platforms. + There are several options supported by this plugin: + + + + + + + A list of uris to expose via UPnP. May be files, folders or anything supported by gvfs. + + + + + + + + A list of filename extensions. If this option is omitted or empty, every file will be analyzed for meta-data. The extensions are case-insensitive. + + + + + + + + Set to false if you do not care about duration or any other meta-data like artist. This speeds up the initial crawl of the media a lot. Use it to quickly share some files via UPnP. Make sure to define an , otherwise you will end up with a lot of files exposed which the client cannot display anyway. + + + + + + Playbin plugin + The Playbin plugin implements a media renderer (Digtal Media Renderer, DMR in DLNA terms). This plugin was known as GstRenderer. It has no special options + + + ZDFMediathek + The ZDF Mediathek http://www.zdf.de/ZDFmediathek is an online archive of broadcasts from the second german television. This plugin can be used to subscribes to the RSS feeds of this service and expose the broadcasts via UPnP. + + + + + + + A list of broadcast ids. How to get the broadcast ids from the web site is described in the file README.Mediathek (in german only). + + + + + + GstLaunch Plugin + The GstLaunch plugin allows to expose GStreamer pipelines using the same syntax as the gst-launch utilty. You can configure several items in this plugins. + + + + + + + A list of of identifiers for the pipelines to be exposed. + + + + + + + + Title of the device represented by this pipeline. Identifier + is the identifier as set in launch-items + + + + + + + + Mime-type of the pipeline. + + + + + + + + Definition of the pipeline in gst-launch syntax. For examples on the syntax see + gst-launch + 1 + . + + + + An example configuration is available in the distributed configuration file /etc/rygel.conf. + + + External + The External plugin is an consumer of the MediaServer2 DBus interface specification as defined at http://live.gnome.org/Rygel/MediaServer2Spec. This allows external programs to share their data via UPnP by implementing this DBus specification. The plugin picks up any implementation of this interface on the session bus and exposes the presented media via UPnP. Known implementors of this spec are gnome-dvb-daemon (http://live.gnome.org/DVBDaemon) and Grilo (http://live.gnome.org/Grilo) via the grilo-rygel project. + This plugin has no additional options. + + + SEE ALSO + + rygel + 1 + , + README.Mediathek, + gst-launch + 1 + + + + diff --git a/doc/man/rygel.xml b/doc/man/rygel.xml new file mode 100644 index 0000000..dd464e2 --- /dev/null +++ b/doc/man/rygel.xml @@ -0,0 +1,396 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A typical entry +in a Makefile or Makefile.am is: + +DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl +XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" + +manpage.1: manpage.xml + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The XSL files are in +docbook-xsl. A description of the parameters you can use can be found in the +docbook-xsl-doc-* packages. Please remember that if you create the nroff +version in one of the debian/rules file targets (such as build), you will need +to include xsltproc and docbook-xsl in your Build-Depends control field. +Alternatively use the xmlto command/package. That will also automatically +pull in xsltproc and docbook-xsl. + +Notes for using docbook2x: docbook2x-man does not automatically create the +AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as + ... . + +To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections +read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be +found in the docbook-xsl-doc-html package. + +Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` + +General documentation about man-pages and man-page-formatting: +man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + +--> + + + + + + + + + + + + + +]> + + + &dhtitle; + &dhpackage; + + + &dhfirstname; + &dhsurname; + Wrote this manpage. +
+ &dhemail; +
+ + + + + &dhucpackage; + &dhsection; + + + &dhpackage; + a collection of DLNA/UPnP AV services + + + + &dhpackage; + + + + + + + DESCRIPTION + &dhpackage; is a collection of DLNA (UPnP AV) services (devices in UPnP speak), implemented through a plug-in mechanism. UPnP in simplest words is a set of protocols that defines how different devices on a home network can seamlessly (without or with minimum configuration) communicate with each other. UPnP AV defines how multimedia systems could be built on top of that. DLNA in simple words is a long list of rules that implementers must comply to if they want to achieve interoperability with other implementations in the market. + + + OPTIONS + The program follows the usual GNU command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + + + + Set the network-interface rygel listens on + + + + + + + + + + + Show summary of options. + + + + + + + + Show all help options + + + + + + + + Show GStreamer related help options + + + + + + + + Show version of program. + + + + + + + + + + + Set the listen-port + + + + + + + + + + + Disable any transcoding + + + + + + + + + + + Disable transcoding to MP3 + + + + + + + + + + + Disable transcoding to MPEG2 in TS container + + + + + + + + + + + Disable transcoding to Linear PCM + + + + + + + + Disable transcoding to WMV + + + + + + + + + + + Set the log level. 1=critical, 2=error, 3=warning, 4=message/info, 5=debug + + + + + + + + + + + Set the plugin search path + + + + + + + + + + + Disable a plugin + + + + + + FILES + + + + /etc/rygel.conf + + + The system-wide configuration file to control the + behaviour of &dhpackage;. See + + rygel.conf + 5 + for further details. + + + + + ${XDG_CONFIG_DIR}/rygel.conf + + + The per-user configuration file to control the + behaviour of &dhpackage;. See + + rygel.conf + 5 + for further details. + + + + + ${XDG_CONFIG_DIR}/Rygel/*.xml + + + Cached UPnP device description files + + + + + + ENVIONMENT + + + + RYGEL_IFACE + + + Set the network interface to bind to. + + + + + RYGEL_PORT + + + Define the network port to bind to + + + + + RYGEL_TRANSCODING + + + Enable or disable transcoding globally + + + + + RYGEL_MP3_TRANS + + + Enable or disable the MP3 transcoder + + + + + RYGEL_LPCM_TRANS + + + Enable or disable the Linear PCM transcoder + + + + + RYGEL_MP2TS_TRANS + + + Enable or disable the MPEG2 in TS transcoder + + + + + RYGEL_WMV_TRANS + + + Enable or disable transcoding to WMV format + + + + + RYGEL_LOG + + + Set the log level of &dhpackage; + + + + + RYGEL_PLUGIN_PATH + + + Set the plugin search path of &dhpackage; + + + + Also for every plugin you can set the following environment variables: + + + + RYGEL_PLUGIN_NAME_TITLE + + + Set the title of the plugin + + + + + RYGEL_PLUGIN_NAME_ENABLED + + + Enable or disable the plugin + + + + + + BUGS + The BTS can be found + at . + + + SEE ALSO + + rygel.conf + 5 + + + -- 2.7.4