GNOME.org
 

[rygel] doc: Some clean-up

commit e6c51f88705b7bc2d14cbe1c89664115fd865d65
Author: Jens Georg <mail jensge org>
Date:   Sat Feb 5 22:56:36 2011 +0100

    doc: Some clean-up
    
    Do some rewording, additional notes and consistency.

 doc/man/rygel.conf.xml |  128 +++++++++++++++++++++++++++++++++--------------
 1 files changed, 90 insertions(+), 38 deletions(-)
---
diff --git a/doc/man/rygel.conf.xml b/doc/man/rygel.conf.xml
index 298ccf2..2653832 100644
--- a/doc/man/rygel.conf.xml
+++ b/doc/man/rygel.conf.xml
@@ -65,7 +65,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     <productname>&dhpackage;</productname>
     <authorgroup>
       <author>
-       <firstname>&dhfirstname;</firstname>
+        <firstname>&dhfirstname;</firstname>
         <surname>&dhsurname;</surname>
         <contrib>Wrote this manpage.</contrib>
         <address>
@@ -92,22 +92,32 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
   </refsynopsisdiv>
   <refsect1 id="description">
     <title>DESCRIPTION</title>
-    <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>
-    <para>Most of the options may be overriden by commandline arguments or envronment variables. See <citerefentry>
+    <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>
+    <para>Most of the options may be overriden by commandline arguments or
+        envronment variables. See <citerefentry>
         <refentrytitle>rygel</refentrytitle>
         <manvolnum>1</manvolnum>
       </citerefentry> for details on those.</para>
   </refsect1>
   <refsect1 id="options">
     <title>GENERAL DIRECTIVES</title>
-    <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>
+    <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>
     <variablelist>
       <varlistentry>
         <term>
           <option>upnp-enabled</option>
         </term>
         <listitem>
-            <para>Enable/disable UPnP sharing of the media files. If set to <varname>false</varname>, <command>&dhpackage;</command> will still offer HTTP proxy URLs for its media files but not actively advertise them via UPnP.</para>
+          <para>Enable/disable UPnP sharing of the media files. If set to
+            <userinput>false</userinput>, <application>&dhpackage;</application>  will
+            still offer HTTP proxy URLs for its media files but not actively
+            advertise them via UPnP.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -115,7 +125,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>interface=<replaceable>INTERFACE</replaceable></option>
         </term>
         <listitem>
-          <para>Set the network-interface rygel listens on.</para>
+          <para>Set the network-interface <application>&dhpackage;</application> listens on.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -131,7 +141,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enable-transcoding</option>
         </term>
         <listitem>
-          <para>Set to  <varname>true</varname> to enable transcoding in general.</para>
+          <para>Set to <userinput>true</userinput> to enable transcoding in
+            general.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -139,7 +151,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enable-mp3-transcoder</option>
         </term>
         <listitem>
-          <para>Set to <varname>true</varname> to enable transcoding to MP3.</para>
+          <para>Set to <userinput>true</userinput> to enable transcoding to MP3.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -147,7 +160,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enable-mp2ts-transcoder</option>
         </term>
         <listitem>
-          <para>Set to <varname>true</varname> to enable transcoding to MPEG2 in TS container.</para>
+          <para>
+            Set to <userinput>true</userinput> to enable transcoding to MPEG2
+            in TS container.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -155,7 +171,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enable-lpcm-transcoder</option>
         </term>
         <listitem>
-          <para>Set to <varname>true</varname> to enable transcoding to Linear PCM.</para>
+          <para>
+            Set to <userinput>true</userinput> to enable transcoding to Linear PCM.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -163,7 +181,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enable-wmv-transcoder</option>
         </term>
         <listitem>
-          <para>Set to <varname>true</varname> to enable transcoding to WMV.</para>
+          <para>
+            Set to <userinput>true</userinput> to enable transcoding to WMV.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -171,7 +191,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>log-level<replaceable>=LEVEL</replaceable></option>
         </term>
         <listitem>
-          <para>Set the log level. 1=critical, 2=error, 3=warning, 4=message/info, 5=debug</para>
+          <para>
+            Set the log level. 1=critical, 2=error, 3=warning, 4=message/info,
+            5=debug.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -179,16 +202,23 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>plugin-path=<replaceable>PATH</replaceable></option>
         </term>
         <listitem>
-          <para>Set the plugin search path</para>
+          <para>Set the plugin search path.</para>
         </listitem>
       </varlistentry>
     </variablelist>
-    <para>Plugin-specific sections are denoted with <option>[PluginName]</option> and can contain plugin-specific options as well as common options: </para>
+    <para>Sections for plugins are denoted with <option>[PluginName]</option>
+      and can contain options specific to a plugin (see below)  as well these common options:
+    </para>
     <variablelist>
       <varlistentry>
         <term><option>title</option>=<replaceable>TITLE</replaceable></term>
         <listitem>
-          <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>
+          <para>Title of the device implemented by this plugin. There are some
+            variables which will be replaced by <application>&dhpackage;</application>.
+            <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 <application>&dhpackage;</application> runs on.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -196,21 +226,29 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>enabled</option>
         </term>
         <listitem>
-          <para>You can individually enable or disable plugins by setting this to <option>true</option> or <option>false</option>.</para>
+          <para>
+            You can individually enable or disable plugins by setting this
+            to <userinput>true</userinput> or <userinput>false</userinput>.
+          </para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
     <title>Tracker Plugin</title>
-    <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>
+    <para>The tracker plugin uses the centralized database of meta information
+      from the tracker project. See the
+      <ulink url="http://www.tracker-project.org";>tracker project website </ulink> for more information about tracker.
+    </para>
     <variablelist>
       <varlistentry>
         <term>
           <option>share-pictures</option>
         </term>
         <listitem>
-          <para>Enable or disable sharing of all pictures in the Tracker database.</para>
+          <para>
+            Enable or disable sharing of all pictures in the Tracker database.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -218,7 +256,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>share-videos</option>
         </term>
         <listitem>
-          <para>Enable or disable sharing of all videos in the Tracker database.</para>
+          <para>
+            Enable or disable sharing of all videos in the Tracker database.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -226,14 +266,24 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>share-music</option>
         </term>
         <listitem>
-          <para>Enable or disable sharing of all music in the Tracker database.</para>
+          <para>
+            Enable or disable sharing of all music in the Tracker database.
+          </para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
     <title>MediaExport Plugin</title>
-    <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>
+    <para>The MediaExport plugin is an alternative to the tracker-backed media export.
+      It extracts meta-data by itself and stores it in a <ulink url="http://sqlite.org";>SQLite </ulink> database in
+      <filename>$XDG_CACHE_DIR/&dhpackage;/media-export.db</filename>
+      on UNIX platforms.
+      <note>
+        <para>If both plugins, Tracker as well as MediaExport are enabled,
+          MediaExport will disable itself in favour of the Tracker plugin.
+        </para>
+      </note></para>
     <para>There are several options supported by this plugin:</para>
     <variablelist>
       <varlistentry>
@@ -241,7 +291,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>uris</option>
         </term>
         <listitem>
-          <para>A list of uris to expose via UPnP. May be files, folders or anything supported by gvfs.</para>
+          <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.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -257,25 +307,26 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>extract-metadata</option>
         </term>
         <listitem>
-          <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>
+          <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>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
     <title>Playbin plugin</title>
-    <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>
+    <para>The Playbin plugin implements a media renderer (Digtal Media Renderer, DMR in DLNA terms). This plugin was known as GstRenderer.</para>
+    <para>This plugin has no special options.</para>
   </refsect1>
   <refsect1>
     <title>ZDFMediathek</title>
-    <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>
+    <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>
     <variablelist>
       <varlistentry>
         <term>
           <option>rss</option>
         </term>
         <listitem>
-          <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>
+          <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>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -283,7 +334,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>update-interval</option>
         </term>
         <listitem>
-          <para>Time in seconds after which the plugin checks for new content. Default is 1800s (30 minutes). The minimum timeout is 10 minutes.</para>
+          <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>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -292,6 +343,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         </term>
         <listitem>
           <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>
+          <note>
+            <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>
+          </note>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -330,26 +384,26 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
           <option>identifier-launch</option>
         </term>
         <listitem>
-          <para>Definition of the pipeline in gst-launch syntax. For examples on the syntax see <citerefentry>
+          <para>Definition of the pipeline in gst-launch syntax. For some examples on writing pipelines  see <citerefentry>
               <refentrytitle>gst-launch</refentrytitle>
               <manvolnum>1</manvolnum>
             </citerefentry>.</para>
         </listitem>
       </varlistentry>
     </variablelist>
-    <para>An example configuration is available in the distributed configuration file <filename>/etc/rygel.conf</filename>.</para>
+    <para>An example configuration is available in the distributed configuration file <filename>/etc/&dhucpackage;</filename>.</para>
   </refsect1>
   <refsect1>
     <title>External</title>
-    <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>
+    <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> and <ulink url="http://live.gnome.org/Grilo";>Grilo </ulink> via the grilo-rygel project.</para>
     <para>This plugin has no additional options.</para>
   </refsect1>
   <refsect1>
     <title>MPRIS</title>
-    <para>The MPRIS plugin is a consumer of the MPRIS2 DBus interface specification as defined at <ulink url="http://www.mpris.org";>http://www.mpris.org</ulink>. The currently implemented version conforms to version 2.0 of the standard.
+    <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.
       </para>
-    <para><command>&dhpackage;</command> 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>
-    <para>Players that implement this spec and are known to work with <command>&dhpackage;</command> are Banshee (<ulink url="http://banshee.fm";>http://banshee.fm</ulink>) and Rhythmbox (<ulink url="http://www.rhythmbox.org";>http://www.rhythmbox.org</ulink>).
+    <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>
+    <para>Players that implement this spec and are known to work with <application>&dhpackage;</application> are  <ulink url="http://banshee.fm";>Banshee</ulink> and  <ulink url="http://www.rhythmbox.org";>Rhythmbox</ulink>.
       </para>
     <para>This plugin has no additional options.</para>
   </refsect1>
@@ -358,11 +412,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
 <!-- In alpabetical order. -->    <para><citerefentry>
         <refentrytitle>rygel</refentrytitle>
         <manvolnum>1</manvolnum>
-      </citerefentry>, <citerefentry>
-        <refentrytitle>README.Mediathek, <citerefentry>
-            <refentrytitle>gst-launch</refentrytitle>
-            <manvolnum>1</manvolnum>
-          </citerefentry></refentrytitle>
+      </citerefentry>, <filename>README.Mediathek</filename>, <citerefentry>
+        <refentrytitle>gst-launch</refentrytitle>
+        <manvolnum>1</manvolnum>
       </citerefentry></para>
   </refsect1>
 </refentry>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]