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
  96         the file <filename>$XDG_CONFIG_DIR/rygel.conf</filename> or a file given on command line with the <userinput>--config</userinput> option. If that file does not exist it uses the file
  97         <filename>/etc/rygel.conf</filename>.</para>
  98     <para>Most of the options may be overriden by commandline arguments or
  99         envronment variables. See <citerefentry>
 100         <refentrytitle>rygel</refentrytitle>
 101         <manvolnum>1</manvolnum>
 102       </citerefentry> for details on those.</para>
 103   </refsect1>
 104   <refsect1 id="options">
 105     <title>GENERAL DIRECTIVES</title>
 106     <para>Lists in the configuration files are separated by a semicolon
 107         (<userinput>;</userinput>). Boolean values may be either
 108         <userinput>true</userinput> or <userinput>false</userinput>.</para>
 109     <variablelist>
 110       <varlistentry>
 111         <term>
 112           <option>upnp-enabled</option>
 113         </term>
 114         <listitem>
 115           <para>Enable/disable UPnP sharing of the media files. If set to
 116             <userinput>false</userinput>, <application>&dhpackage;</application>  will
 117             still offer HTTP proxy URLs for its media files but not actively
 118             advertise them via UPnP.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122       <varlistentry>
 123         <term>
 124           <option>interface=<replaceable>INTERFACE</replaceable></option>
 125         </term>
 126         <listitem>
 127           <para>Set the network-interface <application>&dhpackage;</application> listens on.</para>
 128         </listitem>
 129       </varlistentry>
 130       <varlistentry>
 131         <term>
 132           <option>port=<replaceable>PORT</replaceable></option>
 133         </term>
 134         <listitem>
 135           <para>Set the listen-port.</para>
 136         </listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term>
 140           <option>enable-transcoding</option>
 141         </term>
 142         <listitem>
 143           <para>Set to <userinput>true</userinput> to enable transcoding in
 144             general.
 145           </para>
 146         </listitem>
 147       </varlistentry>
 148       <varlistentry>
 149         <term>
 150           <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
 151         </term>
 152         <listitem>
 153           <para>Comma-separated list of <replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable> pairs, allowing to set the log level individually for each domain, where <replaceable>DOMAIN</replaceable> is eiher <userinput>&quot;*&quot;</userinput>, &quot;<userinput>rygel</userinput>&quot; or the name of a plugin. Allowed log levels are 1=critical, 2=error, 3=warning, 4=message/info,
 154             5=debug.
 155           Note that on recent versions of GLib (&gt;= 2.36) it is required to set the environment variable <envar>G_MESSAGES_DEBUG</envar> to <userinput>all</userinput> to get any debug output.</para>
 156         </listitem>
 157       </varlistentry>
 158       <varlistentry>
 159         <term>
 160           <option>plugin-path=<replaceable>PATH</replaceable></option>
 161         </term>
 162         <listitem>
 163           <para>Set the plugin search path.</para>
 164         </listitem>
 165       </varlistentry>
 166       <varlistentry>
 167         <term>
 168           <option>engine-path=<replaceable>PATH</replaceable></option>
 169         </term>
 170         <listitem>
 171           <para>Set the engine search path.</para>
 172         </listitem>
 173       </varlistentry>
 174       <varlistentry>
 175         <term>
 176           <option>media-engine=<replaceable>ENGINE</replaceable></option>
 177         </term>
 178         <listitem>
 179           <para>Name of the loadable module to use as media engine back-end.</para>
 180         </listitem>
 181       </varlistentry>
 182       <varlistentry>
 183         <term>
 184           <option>allow-upload</option>
 185         </term>
 186         <listitem>
 187           <para>Allow uploading of media files via UPnP.</para>
 188         </listitem>
 189       </varlistentry>
 190       <varlistentry>
 191         <term>
 192           <option>allow-deletion</option>
 193         </term>
 194         <listitem>
 195           <para>Allow remote media file deletion via UPnP.</para>
 196         </listitem>
 197       </varlistentry>
 198       <varlistentry>
 199         <term>
 200           <option>video-upload-folder</option>
 201         </term>
 202         <listitem>
 203           <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded videos. It defaults to <userinput>@VIDEOS@</userinput> which expands to the default directory for video files (usually <filename><envar>$HOME</envar>/Videos</filename>).</para>
 204         </listitem>
 205       </varlistentry>
 206       <varlistentry>
 207         <term>
 208           <option>music-upload-folder</option>
 209         </term>
 210         <listitem>
 211           <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded music files. It defaults to <userinput>@MUSIC@</userinput> which expands to the default directory for music files (usually <filename><envar>$HOME</envar>/Music</filename>).</para>
 212         </listitem>
 213       </varlistentry>
 214       <varlistentry>
 215         <term>
 216           <option>picture-upload-folder</option>
 217         </term>
 218         <listitem>
 219           <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded pictures. It defaults to <userinput>@PICTURES@</userinput> which expands to the default directory for picture files (usually <filename><envar>$HOME</envar>/Pictures</filename>).</para>
 220         </listitem>
 221       </varlistentry>
 222       <varlistentry>
 223         <term>
 224           <option>force-downgrade-for</option>
 225         </term>
 226         <listitem>
 227           <para>Semicolon-separated list of device user-agents (or parts thereof) which need a forced downgrade to <userinput>MediaServer:1</userinput> and/or <userinput>ContentDirectory:1</userinput>.</para>
 228           <para><warning>
 229               <para>Only use this parameter if you know what your&apos;re doing or are being told to do so; overriding the default value might cause incompatibilites. If you find that adding your device here enables its usage with Rygel, please  <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=Rygel&amp;component=IOP">file an IOP bug</ulink> so we can include it into the default configuration.</para>
 230             </warning></para>
 231         </listitem>
 232       </varlistentry>
 233     </variablelist>
 234     <para>Sections for plugins are denoted with <option>[PluginName]</option>
 235       and can contain options specific to a plugin (see below)  as well these common options:
 236     </para>
 237     <variablelist>
 238       <varlistentry>
 239         <term><option>title</option>=<replaceable>TITLE</replaceable></term>
 240         <listitem>
 241           <para>Title of the device implemented by this plugin. There are some
 242             variables which will be replaced by <application>&dhpackage;</application>.
 243             <replaceable>@REALNAME@</replaceable> will be subsituted by the
 244             user&apos;s real name, <replaceable>@USERNAME@</replaceable> by the
 245             user&apos;s login id and <replaceable>@HOSTNAME@</replaceable> by
 246             the name of the machine <application>&dhpackage;</application> runs on.</para>
 247         </listitem>
 248       </varlistentry>
 249       <varlistentry>
 250         <term>
 251           <option>enabled</option>
 252         </term>
 253         <listitem>
 254           <para>
 255             You can individually enable or disable plugins by setting this
 256             to <userinput>true</userinput> or <userinput>false</userinput>.
 257           </para>
 258         </listitem>
 259       </varlistentry>
 260     </variablelist>
 261   </refsect1>
 262   <refsect1>
 263     <title>GStreamer Media Engine settings</title>
 264     <para>The settings in the <code>[GstMediaEngine]</code> section are specific to the Gstreamer media engine, which is the default media engine. See the media-engine setting. These following options are available for the <ulink url="http://gstreamer.freedesktop.org">GStreamer</ulink> media engine.</para>
 265     <variablelist>
 266       <varlistentry>
 267         <term>
 268           <option>transcoders</option>
 269         </term>
 270         <listitem>
 271           <para>A semicolon-separated list of the active transcoders. This setting has no effect if <option>enable-transcoding</option> is set to <code>false</code>. Possible values are: <code>lpcm,mp3,mp2ts,aac,avc</code> or <code>wmv</code>. Its default value is <code>lpcm;mp3;mp2ts;aac;wmv</code>.</para>
 272         </listitem>
 273       </varlistentry>
 274     </variablelist>
 275   </refsect1>
 276   <refsect1>
 277     <title>Tracker Plugin</title>
 278     <para>The tracker plugin uses the centralized database of meta information
 279       from the tracker project. See the
 280       <ulink url="http://projects.gnome.org/tracker/">tracker project website </ulink> for more information about tracker.
 281     </para>
 282     <variablelist>
 283       <varlistentry>
 284         <term>
 285           <option>share-pictures</option>
 286         </term>
 287         <listitem>
 288           <para>
 289             Enable or disable sharing of all pictures in the Tracker database.
 290           </para>
 291         </listitem>
 292       </varlistentry>
 293       <varlistentry>
 294         <term>
 295           <option>share-videos</option>
 296         </term>
 297         <listitem>
 298           <para>
 299             Enable or disable sharing of all videos in the Tracker database.
 300           </para>
 301         </listitem>
 302       </varlistentry>
 303       <varlistentry>
 304         <term>
 305           <option>share-music</option>
 306         </term>
 307         <listitem>
 308           <para>
 309             Enable or disable sharing of all music in the Tracker database.
 310           </para>
 311         </listitem>
 312       </varlistentry>
 313     </variablelist>
 314   </refsect1>
 315   <refsect1>
 316     <title>MediaExport Plugin</title>
 317     <para>The MediaExport plugin is an alternative to the tracker-backed media export.
 318       It extracts meta-data by itself and stores it in a <ulink url="http://sqlite.org">SQLite </ulink> database in
 319       <filename>$XDG_CACHE_DIR/&dhpackage;/media-export.db</filename>
 320       on UNIX platforms.
 321       <note>
 322         <para>If both plugins, Tracker as well as MediaExport are enabled,
 323           MediaExport will disable itself in favour of the Tracker plugin.
 324         </para>
 325       </note></para>
 326     <para>There are several options supported by this plugin:</para>
 327     <variablelist>
 328       <varlistentry>
 329         <term>
 330           <option>uris</option>
 331         </term>
 332         <listitem>
 333           <para>A list of URIS to expose via UPnP. May be files, folders or anything supported by GVFS. If left emtpy it defaults to export the user&apos;s music, video and picture folders as defined per XDG special user directories spec. These default folders can be referenced by <userinput>@MUSIC@</userinput>, <userinput>@PICTURES@</userinput> and <userinput>@VIDEOS@</userinput>. Locations can be entered as either fully escaped URIS or normal paths.</para>
 334           <para><note>
 335               <para>If you enter a normal path that contains whitespace there is no need to escape them with either a backslash or putting the string in quotes.</para>
 336             </note></para>
 337           <example>
 338             <title>Possible values for <userinput>uris</userinput></title>
 339             <para/>
 340             <para><userinput>uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos</userinput></para>
 341           </example>
 342         </listitem>
 343       </varlistentry>
 344       <varlistentry>
 345         <term>
 346           <option>extract-metadata</option>
 347         </term>
 348         <listitem>
 349           <para>Set to <userinput>false</userinput> 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>
 350         </listitem>
 351       </varlistentry>
 352       <varlistentry>
 353         <term>
 354           <option>monitor-changes</option>
 355         </term>
 356         <listitem>
 357           <para>Set to <userinput>false</userinput> if you don&apos;t want to have new files picked up automatically by &dhpackage;.</para>
 358         </listitem>
 359       </varlistentry>
 360       <varlistentry>
 361         <term>
 362           <option>virtual-folders</option>
 363         </term>
 364         <listitem>
 365           <para>Set to <userinput>false</userinput> if you don&apos;t need the virtual folder hierarchy.</para>
 366         </listitem>
 367       </varlistentry>
 368     </variablelist>
 369   </refsect1>
 370   <refsect1>
 371     <title>Playbin plugin</title>
 372     <para>The Playbin plugin implements a media renderer (Digtal Media Renderer, DMR in DLNA terms). This plugin was known as GstRenderer.</para>
 373     <para>This plugin has no special options.</para>
 374   </refsect1>
 375   <refsect1>
 376     <title>ZDFMediathek</title>
 377     <para>The  <ulink url="http://www.zdf.de/ZDFmediathek">ZDF Mediathek</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>
 378     <variablelist>
 379       <varlistentry>
 380         <term>
 381           <option>rss</option>
 382         </term>
 383         <listitem>
 384           <para>A list of broadcast ids. How to get the broadcast ids from the web site is described in the file <filename>README.Mediathek</filename> (in german only).</para>
 385         </listitem>
 386       </varlistentry>
 387       <varlistentry>
 388         <term>
 389           <option>update-interval</option>
 390         </term>
 391         <listitem>
 392           <para>Time in seconds after which the plugin checks for new content. The default interval is 1800 seconds (30 minutes), the minimum interval 10 minutes.</para>
 393         </listitem>
 394       </varlistentry>
 395       <varlistentry>
 396         <term>
 397           <option>video-format</option>
 398         </term>
 399         <listitem>
 400           <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>
 401           <note>
 402             <para>Proxying of general RTSP in <application>&dhpackage;</application> as used by the H.264 streams is currently not working very well. Please enable mp4 only if your renderer can handle RTSP by itself.</para>
 403           </note>
 404         </listitem>
 405       </varlistentry>
 406     </variablelist>
 407   </refsect1>
 408   <refsect1>
 409     <title>GstLaunch Plugin</title>
 410     <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>
 411     <variablelist>
 412       <varlistentry>
 413         <term>
 414           <option>launch-items</option>
 415         </term>
 416         <listitem>
 417           <para>A list of of identifiers for the pipelines to be exposed. </para>
 418         </listitem>
 419       </varlistentry>
 420       <varlistentry>
 421         <term>
 422           <option>identifier-title</option>
 423         </term>
 424         <listitem>
 425           <para>Title of the device represented by this pipeline. Identifier
 426               is the identifier as set in launch-items</para>
 427         </listitem>
 428       </varlistentry>
 429       <varlistentry>
 430         <term>
 431           <option>identifier-mime</option>
 432         </term>
 433         <listitem>
 434           <para>Mime-type of the pipeline.</para>
 435         </listitem>
 436       </varlistentry>
 437       <varlistentry>
 438         <term>
 439           <option>identifier-launch</option>
 440         </term>
 441         <listitem>
 442           <para>Definition of the pipeline in gst-launch syntax. For some examples on writing pipelines  see <citerefentry>
 443               <refentrytitle>gst-launch</refentrytitle>
 444               <manvolnum>1</manvolnum>
 445             </citerefentry>.</para>
 446         </listitem>
 447       </varlistentry>
 448       <varlistentry>
 449         <term>
 450           <option>identifier-dlnaprofile</option>
 451         </term>
 452         <listitem>
 453           <para>DLNA profile for the stream.</para>
 454         </listitem>
 455       </varlistentry>
 456     </variablelist>
 457     <para>An example configuration is available in the distributed configuration file <filename>/etc/&dhucpackage;</filename>.</para>
 458   </refsect1>
 459   <refsect1>
 460     <title>External</title>
 461     <para>The External plugin is an consumer of the <ulink url="http://live.gnome.org/Rygel/MediaServer2Spec">MediaServer2 DBus interface specification</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  <ulink url="http://live.gnome.org/DVBDaemon">gnome-dvb-daemon</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="http://live.gnome.org/Grilo">Grilo </ulink> via the grilo-ms2 project.</para>
 462     <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[External]</userinput> section of the configuration file.</para>
 463     <para>Individual peers may be enabled or disabled by creating sections corresponding to the D-Bus names of the peer:</para>
 464     <programlisting>[org.gnome.UPnP.MediaServer2.Rhythmbox]
 465 enabled=false</programlisting>
 466     <para>This plugin has no additional options.</para>
 467   </refsect1>
 468   <refsect1>
 469     <title>MPRIS</title>
 470     <para>The MPRIS plugin is a consumer of the  <ulink url="http://www.mpris.org">MPRIS2 DBus interface specification</ulink>. The implementation conforms to version 2.0 of the standard.
 471       </para>
 472     <para><application>&dhpackage;</application> exposes media players that implement the provider side of this DBus specification as DLNA Digital Media Renderers (DMR) similar to the Playbin plugin. This means that you can easily turn your media player into a DMR by implementing this DBus specification.</para>
 473     <para>Players that implement this spec and are known to work with <application>&dhpackage;</application> are  <ulink url="http://banshee.fm">Banshee</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="http://live.gnome.org/Totem">Totem</ulink>
 474       </para>
 475     <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[MRPIS]</userinput> section of the configuration file.</para>
 476     <para>The configuration of this plugin is special. Plugin configuration is not done on the plugin but rather per peer that is found providing the MPRIS2 interface. See the following example to set the title for Banshee on MPRIS:</para>
 477     <para><programlisting>[org.mpris.MediaPlayer2.banshee]
 478 title=@REALNAME@&apos;s Banshee on @HOSTNAME@</programlisting></para>
 479     <para>This plugin has no additional options.</para>
 480   </refsect1>
 481   <refsect1 id="see_also">
 482     <title>SEE ALSO</title>
 483 <!-- In alpabetical order. -->    <para><citerefentry>
 484         <refentrytitle>rygel</refentrytitle>
 485         <manvolnum>1</manvolnum>
 486       </citerefentry>, <filename>README.Mediathek</filename>, <citerefentry>
 487         <refentrytitle>gst-launch</refentrytitle>
 488         <manvolnum>1</manvolnum>
 489       </citerefentry></para>
 490   </refsect1>
 491 </refentry>