]> kaliko git repositories - mpd-sima.git/blobdiff - data/man/mpd_sima.cfg.5.xml
Add priority to plugins
[mpd-sima.git] / data / man / mpd_sima.cfg.5.xml
index cb6f47dcc0717f4ee7bece2442ae85b7a3f79b43..b6bd1237a9e2f1291a109fd9f435da11b5e04ce2 100644 (file)
@@ -57,8 +57,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
   </refmeta>
     <refnamediv>
         <refname>&dhutils;</refname>
-        <refpurpose>&dhpackage; will try to maintain some titles ahead in your play
-            list following different policies. This manual document the
+        <refpurpose>&dhpackage; will try to maintain some titles ahead in the queue
+            following different policies. This manual document the
             configuration file for &dhpackage;.</refpurpose>
     </refnamediv>
     <refsect1 id="description">
@@ -129,8 +129,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
             </variablelist>
         </refsect2>
         <refsect2 id="log">
-            <para>Configure logging.</para>
             <title>log section</title>
+            <para>Configure logging.</para>
             <variablelist>
                 <varlistentry> <!-- LOG -->
                     <term><option>[log]</option></term>
@@ -155,9 +155,31 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 </varlistentry>
             </variablelist>
         </refsect2>
+        <refsect2 id="daemon">
+            <title>Process daemonization</title>
+            <para>Configure process daemon.</para>
+            <variablelist>
+                <varlistentry> <!-- DAEMON -->
+                    <term><option>[daemon]</option></term>
+                    <listitem><para></para></listitem>
+                </varlistentry>
+                <varlistentry> <!-- daemon.daemon -->
+                    <term><option>daemon=false</option></term>
+                    <listitem>
+                        <para>whether to daemonize process or not.</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- daemon.pidfile -->
+                    <term><option>pidfile=</option></term>
+                    <listitem>
+                        <para>Where to store process ID.</para>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+        </refsect2>
         <refsect2 id="sima">
             <title>sima section</title>
-            <para>This section allows you to tweak core &dhutils; configuration.</para>
+            <para>Core &dhutils; configuration.</para>
             <variablelist>
                 <varlistentry> <!-- SIMA -->
                     <term><option>[sima]</option></term>
@@ -174,16 +196,22 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- sima.queue_length -->
                     <term><option>queue_length=</option><replaceable>1</replaceable></term>
                     <listitem>
-                        <para>This value triggers queue process if the play
-                            list length is less than specified
+                        <para>This value triggers queue process if the queue
+                            length is less than specified
                             queue_length.</para>
                     </listitem>
                 </varlistentry>
-                <varlistentry> <!-- sima.user_db -->
-                    <term><option>user_db=</option><replaceable>false</replaceable></term>
+                <varlistentry> <!-- sima.musicbrainzid -->
+                    <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
                     <listitem>
-                        <para>Temporarily removed feature</para>
-                        <!--<para>Look for user defined similarities in user data base.</para>-->
+                        <para>Use MusicBrainzIdentifier to search music (mainly
+                            for artists). Consider using these metadata as it
+                            enhances a lot artist/album/tracks identification.<sbr />
+                            Default is True, switch to False if you don't have
+                            MusicBrainzIdentifier set for at least 80% of you
+                            music library.<sbr />
+                            Use Picard to tag your file: <ulink url="https://picard.musicbrainz.org/"/>.
+                        </para>
                     </listitem>
                 </varlistentry>
             </variablelist>
@@ -194,13 +222,13 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 "AwesomePlugin" declared here gets its configuration from the
                 corresponding section "[awesomeplugin]".<sbr />internal plugins
                 will look for a section named after the lower-cased name of the
-                pluglin, ie.  RandomFallBack → randomfallback.
+                plugin, ie.  Random → random.
             </para>
             <variablelist>
                 <varlistentry> <!-- sima.internal -->
-                    <term><option>internal=</option><replaceable>Crop, RandomFallBack, Lastfm</replaceable></term>
+                    <term><option>internal=</option><replaceable>Crop, Random, Lastfm</replaceable></term>
                     <listitem>
-                        <para><option>Crop</option> and <option>RandomFallback</option>
+                        <para><option>Crop</option> and <option>Random</option>
                             are utilities plugins while <option>Lastfm</option> is the
                             actual queue plugin.<sbr /> Another queue plugin is available as
                             a "techno preview", it relies on EchoNest web services, replace
@@ -224,20 +252,20 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- crop.consume -->
                     <term><option>consume=</option><replaceable>0</replaceable></term>
                     <listitem>
-                        <para>How many played tracks to keep in the play list.
-                            Allow to maintain a fixed length play list.
+                        <para>How many played tracks to keep in the queue.
+                            Allows you to maintain a fixed length queue.
                             Set to 0 to keep all played tracks.
                         </para>
                     </listitem>
                 </varlistentry>
         </refsect2>
-        <refsect2 id="randomfallback">
-            <title>RandomFallback section</title>
-            <para>RandomFallback plugin's configuration:</para>
-                <varlistentry> <!-- randomfallback -->
-                    <term><option>[randomfallback]</option></term>
+        <refsect2 id="random">
+            <title>Random section</title>
+            <para>Random plugin's configuration:</para>
+                <varlistentry> <!-- random -->
+                    <term><option>[random]</option></term>
                 </varlistentry>
-                <varlistentry> <!-- randomfallback.flavour -->
+                <varlistentry> <!-- random.flavour -->
                     <term><option>flavour=</option><replaceable>sensible</replaceable></term>
                     <listitem>
                         <para>When no similar tracks are found, falling back to
@@ -266,7 +294,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         </refsect2>
         <refsect2 id="lastfm">
             <title>LastFm section</title>
-            <para>This section allows you to tweak LastFM plugin's configuration.</para>
+            <para>LastFM plugin's configuration.</para>
             <variablelist>
                 <varlistentry> <!-- lastfm -->
                     <term><option>[lastfm]</option></term>
@@ -295,7 +323,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                         <para>How many artists to base on similar artists
                             search.<sbr /> The first is the last played artist
                             and so on back in the history. Highter depth
-                            allows to get wider suggestions, it might help to
+                            generates wider suggestions, it might help to
                             reduce looping over same artists.
                             </para>
                     </listitem>
@@ -341,7 +369,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
     <refsect1 id="queue_mode">
         <title>QUEUE MODES</title>
         <para>&dhpackage; offers different queue modes. All of them pick up
-            tracks from artists similar to the one currently played.</para>
+            tracks from artists similar to the last track in the queue.</para>
         <para>&dhpackage; tries preferably to chose among unplayed artists or
             at least not recently played artist. Concerning track and album
             queue modes titles are chosen purely at random among unplayed