doc: Clarify debug output settings
[profile/ivi/rygel.git] / doc / man / rygel.conf.xml
index bc862ae..1193a88 100644 (file)
@@ -147,80 +147,36 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
       </varlistentry>
       <varlistentry>
         <term>
-          <option>enable-mp3-transcoder</option>
-        </term>
-        <listitem>
-          <para>Set to <userinput>true</userinput> to enable transcoding to MP3.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>
-          <option>enable-mp2ts-transcoder</option>
-        </term>
-        <listitem>
-          <para>
-            Set to <userinput>true</userinput> to enable transcoding to MPEG2
-            in TS container.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>
-          <option>enable-lpcm-transcoder</option>
-        </term>
-        <listitem>
-          <para>
-            Set to <userinput>true</userinput> to enable transcoding to Linear PCM.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>
-          <option>enable-wmv-transcoder</option>
-        </term>
-        <listitem>
-          <para>
-            Set to <userinput>true</userinput> to enable transcoding to WMV.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>
-          <option>enable-aac-transcoder</option>
+          <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
         </term>
         <listitem>
-          <para>
-            Set to <userinput>true</userinput> to enable transcoding to AAC.
-          </para>
+          <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,
+            5=debug.
+          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>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>
-          <option>enable-avc-transcoder</option>
+          <option>plugin-path=<replaceable>PATH</replaceable></option>
         </term>
         <listitem>
-          <para>
-            Set to <userinput>true</userinput> to enable transcoding to AVC.
-          </para>
+          <para>Set the plugin search path.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>
-          <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
+          <option>engine-path=<replaceable>PATH</replaceable></option>
         </term>
         <listitem>
-          <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,
-            5=debug.
-          </para>
+          <para>Set the engine search path.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>
-          <option>plugin-path=<replaceable>PATH</replaceable></option>
+          <option>media-engine=<replaceable>ENGINE</replaceable></option>
         </term>
         <listitem>
-          <para>Set the plugin search path.</para>
+          <para>Name of the loadable module to use as media engine back-end.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -304,6 +260,20 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     </variablelist>
   </refsect1>
   <refsect1>
+    <title>GStreamer Media Engine settings</title>
+    <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>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <option>transcoders</option>
+        </term>
+        <listitem>
+          <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>
+        </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 the
@@ -373,26 +343,26 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
       </varlistentry>
       <varlistentry>
         <term>
-          <option>include-filter</option>
+          <option>extract-metadata</option>
         </term>
         <listitem>
-          <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>
+          <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>
       <varlistentry>
         <term>
-          <option>extract-metadata</option>
+          <option>monitor-changes</option>
         </term>
         <listitem>
-          <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>
+          <para>Set to <userinput>false</userinput> if you don&apos;t want to have new files picked up automatically by &dhpackage;.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>
-          <option>monitor-changes</option>
+          <option>virtual-folders</option>
         </term>
         <listitem>
-          <para>Set to <userinput>false</userinput> if you don&apos;t want to have new files picked up automatically by &dhpackage;.</para>
+          <para>Set to <userinput>false</userinput> if you don&apos;t need the virtual folder hierarchy.</para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -475,6 +445,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
             </citerefentry>.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term>
+          <option>identifier-dlnaprofile</option>
+        </term>
+        <listitem>
+          <para>DLNA profile for the stream.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
     <para>An example configuration is available in the distributed configuration file <filename>/etc/&dhucpackage;</filename>.</para>
   </refsect1>