doc/man/rygel.conf.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- This document was created with Syntext Serna Free. --><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   3
   4 <!--
   5
   6 `xsltproc -''-nonet \
   7           -''-param man.charmap.use.subset "0" \
   8           -''-param make.year.ranges "1" \
   9           -''-param make.single.year.ranges "1" \
  10           /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
  11           manpage.xml'
  12
  13 A manual page <package>.<section> will be generated. You may view the
  14 manual page with: nroff -man <package>.<section> | less'. A typical entry
  15 in a Makefile or Makefile.am is:
  16
  17 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
  18 XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
  19
  20 manpage.1: manpage.xml
  21         $(XP) $(DB2MAN) $<
  22
  23 The xsltproc binary is found in the xsltproc package. The XSL files are in
  24 docbook-xsl. A description of the parameters you can use can be found in the
  25 docbook-xsl-doc-* packages. Please remember that if you create the nroff
  26 version in one of the debian/rules file targets (such as build), you will need
  27 to include xsltproc and docbook-xsl in your Build-Depends control field.
  28 Alternatively use the xmlto command/package. That will also automatically
  29 pull in xsltproc and docbook-xsl.
  30
  31 Notes for using docbook2x: docbook2x-man does not automatically create the
  32 AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
  33 <refsect1> ... </refsect1>.
  34
  35 To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
  36 read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
  37 found in the docbook-xsl-doc-html package.
  38
  39 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
  40
  41 General documentation about man-pages and man-page-formatting:
  42 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
  43
  44 -->
  45
  46   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  47   <!ENTITY dhfirstname "Jens">
  48   <!ENTITY dhsurname   "Georg">
  49   <!-- dhusername could also be set to "&firstname; &surname;". -->
  50   <!ENTITY dhusername  "Jens Georg">
  51   <!ENTITY dhemail     "mail@jensge.org">
  52   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  53        allowed: see man(7), man(1) and
  54        http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
  55   <!ENTITY dhsection   "5">
  56   <!-- TITLE should be something like "User commands" or similar (see
  57        http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
  58   <!ENTITY dhtitle     "Rygel User Manual">
  59   <!ENTITY dhucpackage "rygel.conf">
  60   <!ENTITY dhpackage   "rygel">
  61 ]>
  62 <refentry>
  63   <refentryinfo>
  64     <title>&dhtitle;</title>
  65     <productname>&dhpackage;</productname>
  66     <authorgroup>
  67       <author>
  68        <firstname>&dhfirstname;</firstname>
  69         <surname>&dhsurname;</surname>
  70         <contrib>Wrote this manpage.</contrib>
  71         <address>
  72           <email>&dhemail;</email>
  73         </address>
  74       </author>
  75     </authorgroup>
  76   </refentryinfo>
  77   <refmeta>
  78     <refentrytitle>&dhucpackage;</refentrytitle>
  79     <manvolnum>&dhsection;</manvolnum>
  80   </refmeta>
  81   <refnamediv>
  82     <refname>&dhucpackage;</refname>
  83     <refpurpose>Rygel configuration file </refpurpose>
  84   </refnamediv>
  85   <refsynopsisdiv>
  86     <cmdsynopsis>
  87       <command>$XDG_CONFIG_DIR/rygel.conf</command>
  88     </cmdsynopsis>
  89     <cmdsynopsis>
  90       <command>/etc/rygel.conf</command>
  91     </cmdsynopsis>
  92   </refsynopsisdiv>
  93   <refsect1 id="description">
  94     <title>DESCRIPTION</title>
  95     <para><command>&dhpackage;</command> reads its configuration values from the file <filename>$XDG_CONFIG_DIR/rygel.conf</filename> or - if that file does not exist - from the file <filename>/etc/rygel.conf</filename>.</para>
  96     <para>Most of the options may be overriden by commandline arguments or envronment variables. See <citerefentry>
  97         <refentrytitle>rygel</refentrytitle>
  98         <manvolnum>1</manvolnum>
  99       </citerefentry> for details on those.</para>
 100   </refsect1>
 101   <refsect1 id="options">
 102     <title>GENERAL DIRECTIVES</title>
 103     <para>Lists in the configuration files are separated by a semicolon (<userinput>;</userinput>). Boolean values may be either <userinput>true</userinput> or <userinput>false</userinput>.</para>
 104     <variablelist>
 105       <varlistentry>
 106         <term>
 107           <option>interface=<replaceable>INTERFACE</replaceable></option>
 108         </term>
 109         <listitem>
 110           <para>Set the network-interface rygel listens on.</para>
 111         </listitem>
 112       </varlistentry>
 113       <varlistentry>
 114         <term>
 115           <option>port=<replaceable>PORT</replaceable></option>
 116         </term>
 117         <listitem>
 118           <para>Set the listen-port.</para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term>
 123           <option>enable-transcoding</option>
 124         </term>
 125         <listitem>
 126           <para>Set to  <varname>true</varname> to enable transcoding in general.</para>
 127         </listitem>
 128       </varlistentry>
 129       <varlistentry>
 130         <term>
 131           <option>enable-mp3-transcoder</option>
 132         </term>
 133         <listitem>
 134           <para>Set to <varname>true</varname> to enable transcoding to MP3.</para>
 135         </listitem>
 136       </varlistentry>
 137       <varlistentry>
 138         <term>
 139           <option>enable-mp2ts-transcoder</option>
 140         </term>
 141         <listitem>
 142           <para>Set to <varname>true</varname> to enable transcoding to MPEG2 in TS container.</para>
 143         </listitem>
 144       </varlistentry>
 145       <varlistentry>
 146         <term>
 147           <option>enable-lpcm-transcoder</option>
 148         </term>
 149         <listitem>
 150           <para>Set to <varname>true</varname> to enable transcoding to Linear PCM.</para>
 151         </listitem>
 152       </varlistentry>
 153       <varlistentry>
 154         <term>
 155           <option>enable-wmv-transcoder</option>
 156         </term>
 157         <listitem>
 158           <para>Set to <varname>true</varname> to enable transcoding to WMV.</para>
 159         </listitem>
 160       </varlistentry>
 161       <varlistentry>
 162         <term>
 163           <option>log-level<replaceable>=LEVEL</replaceable></option>
 164         </term>
 165         <listitem>
 166           <para>Set the log level. 1=critical, 2=error, 3=warning, 4=message/info, 5=debug</para>
 167         </listitem>
 168       </varlistentry>
 169       <varlistentry>
 170         <term>
 171           <option>plugin-path=<replaceable>PATH</replaceable></option>
 172         </term>
 173         <listitem>
 174           <para>Set the plugin search path</para>
 175         </listitem>
 176       </varlistentry>
 177     </variablelist>
 178     <para>Plugin-specific sections are denoted with <option>[PluginName]</option> and can contain plugin-specific options as well as common options: </para>
 179     <variablelist>
 180       <varlistentry>
 181         <term><option>title</option>=<replaceable>TITLE</replaceable></term>
 182         <listitem>
 183           <para>Title of the device implemented by this plugin. There are some variables which will be replaced by &dhpackage;. <replaceable>@REALNAME@</replaceable> will be subsituted by the user&apos;s real name, <replaceable>@USERNAME@</replaceable> by the user&apos;s login id and <replaceable>@HOSTNAME@</replaceable> by the name of the machine &dhpackage;runs on.</para>
 184         </listitem>
 185       </varlistentry>
 186       <varlistentry>
 187         <term>
 188           <option>enabled</option>
 189         </term>
 190         <listitem>
 191           <para>You can individually enable or disable plugins by setting this to <option>true</option> or <option>false</option>.</para>
 192         </listitem>
 193       </varlistentry>
 194     </variablelist>
 195   </refsect1>
 196   <refsect1>
 197     <title>Tracker Plugin</title>
 198     <para>The tracker plugin uses the centralized database of meta information from the tracker project. See <ulink url="http://www.tracker-project.org">http://www.tracker-project.org</ulink> for more information about tracker.</para>
 199     <variablelist>
 200       <varlistentry>
 201         <term>
 202           <option>share-pictures</option>
 203         </term>
 204         <listitem>
 205           <para>Enable or disable sharing of all pictures in the Tracker database.</para>
 206         </listitem>
 207       </varlistentry>
 208       <varlistentry>
 209         <term>
 210           <option>share-videos</option>
 211         </term>
 212         <listitem>
 213           <para>Enable or disable sharing of all videos in the Tracker database.</para>
 214         </listitem>
 215       </varlistentry>
 216       <varlistentry>
 217         <term>
 218           <option>share-music</option>
 219         </term>
 220         <listitem>
 221           <para>Enable or disable sharing of all music in the Tracker database.</para>
 222         </listitem>
 223       </varlistentry>
 224     </variablelist>
 225   </refsect1>
 226   <refsect1>
 227     <title>MediaExport Plugin</title>
 228     <para>MediaExport is an alternative to the Tracker-backed media export. MediaExport extracts meta-data by itself and stores it in the SQLite database in <filename>$XDG_CACHE_DIR/rygel/media-export.db</filename> on UNIX platforms.</para>
 229     <para>There are several options supported by this plugin:</para>
 230     <variablelist>
 231       <varlistentry>
 232         <term>
 233           <option>uris</option>
 234         </term>
 235         <listitem>
 236           <para>A list of uris to expose via UPnP. May be files, folders or anything supported by gvfs.</para>
 237         </listitem>
 238       </varlistentry>
 239       <varlistentry>
 240         <term>
 241           <option>include-filter</option>
 242         </term>
 243         <listitem>
 244           <para>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.</para>
 245         </listitem>
 246       </varlistentry>
 247       <varlistentry>
 248         <term>
 249           <option>extract-metadata</option>
 250         </term>
 251         <listitem>
 252           <para>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 <option>include-filter</option>, otherwise you will end up with a lot of files exposed which the client cannot display anyway.</para>
 253         </listitem>
 254       </varlistentry>
 255     </variablelist>
 256   </refsect1>
 257   <refsect1>
 258     <title>Playbin plugin</title>
 259     <para>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</para>
 260   </refsect1>
 261   <refsect1>
 262     <title>ZDFMediathek</title>
 263     <para>The ZDF Mediathek <ulink url="http://www.zdf.de/ZDFmediathek">http://www.zdf.de/ZDFmediathek</ulink> 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.</para>
 264     <variablelist>
 265       <varlistentry>
 266         <term>
 267           <option>rss</option>
 268         </term>
 269         <listitem>
 270           <para>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).</para>
 271         </listitem>
 272       </varlistentry>
 273       <varlistentry>
 274         <term>
 275           <option>update-interval</option>
 276         </term>
 277         <listitem>
 278           <para>Time in seconds after which the plugin checks for new content. Default is 1800s (30 minutes). The minimum timeout is 10 minutes.</para>
 279         </listitem>
 280       </varlistentry>
 281       <varlistentry>
 282         <term>
 283           <option>video-format</option>
 284         </term>
 285         <listitem>
 286           <para>The mediathek usually offers the videos in two formats, WMV and H.264. Possible values here are wmv and mp4. The default video format is wmv.</para>
 287         </listitem>
 288       </varlistentry>
 289     </variablelist>
 290   </refsect1>
 291   <refsect1>
 292     <title>GstLaunch Plugin</title>
 293     <para>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.</para>
 294     <variablelist>
 295       <varlistentry>
 296         <term>
 297           <option>launch-items</option>
 298         </term>
 299         <listitem>
 300           <para>A list of of identifiers for the pipelines to be exposed. </para>
 301         </listitem>
 302       </varlistentry>
 303       <varlistentry>
 304         <term>
 305           <option>identifier-title</option>
 306         </term>
 307         <listitem>
 308           <para>Title of the device represented by this pipeline. Identifier
 309               is the identifier as set in launch-items</para>
 310         </listitem>
 311       </varlistentry>
 312       <varlistentry>
 313         <term>
 314           <option>identifier-mime</option>
 315         </term>
 316         <listitem>
 317           <para>Mime-type of the pipeline.</para>
 318         </listitem>
 319       </varlistentry>
 320       <varlistentry>
 321         <term>
 322           <option>identifier-launch</option>
 323         </term>
 324         <listitem>
 325           <para>Definition of the pipeline in gst-launch syntax. For examples on the syntax see <citerefentry>
 326               <refentrytitle>gst-launch</refentrytitle>
 327               <manvolnum>1</manvolnum>
 328             </citerefentry>.</para>
 329         </listitem>
 330       </varlistentry>
 331     </variablelist>
 332     <para>An example configuration is available in the distributed configuration file <filename>/etc/rygel.conf</filename>.</para>
 333   </refsect1>
 334   <refsect1>
 335     <title>External</title>
 336     <para>The External plugin is an consumer of the MediaServer2 DBus interface specification as defined at <ulink url="http://live.gnome.org/Rygel/MediaServer2Spec">http://live.gnome.org/Rygel/MediaServer2Spec</ulink>. 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 (<ulink url="http://live.gnome.org/DVBDaemon">http://live.gnome.org/DVBDaemon</ulink>) and Grilo (<ulink url="http://live.gnome.org/Grilo">http://live.gnome.org/Grilo</ulink>) via the grilo-rygel project.</para>
 337     <para>This plugin has no additional options.</para>
 338   </refsect1>
 339   <refsect1 id="see_also">
 340     <title>SEE ALSO</title>
 341 <!-- In alpabetical order. -->    <para><citerefentry>
 342         <refentrytitle>rygel</refentrytitle>
 343         <manvolnum>1</manvolnum>
 344       </citerefentry>, <citerefentry>
 345         <refentrytitle>README.Mediathek, <citerefentry>
 346             <refentrytitle>gst-launch</refentrytitle>
 347             <manvolnum>1</manvolnum>
 348           </citerefentry></refentrytitle>
 349       </citerefentry></para>
 350   </refsect1>
 351 </refentry>