doc: Update sphinx config, add user documentation

[mpd-sima.git] / data / man / mpd_sima.cfg.5.xml

diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml
index b015874fe27870f110ac23374520060fe785c995..c8efb9672061f40688828f32ba774d75a1fb2f82 100644 (file)
--- a/data/man/mpd_sima.cfg.5.xml
+++ b/data/man/mpd_sima.cfg.5.xml
@@ -289,6 +289,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
         </refsect2>
         <refsect2 id="random">
             <title>Random section</title>
+            <para>When no similar tracks are found, falling back to random queuing.</para>
             <para>Random plugin's configuration:</para>
                 <varlistentry> <!-- random -->
                     <term><option>[random]</option></term>
@@ -302,12 +303,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- random.flavour -->
                     <term><option>flavour=</option><replaceable>sensible</replaceable></term>
                     <listitem>
-                        <para>When no similar tracks are found, falling back to
-                            random queuing. Different mode, aka random flavour,
+                        <para>Different mode, aka random flavour,
                             are available:
                             <replaceable>pure</replaceable>,
                             <replaceable>sensible</replaceable>,
-                            <replaceable>genre</replaceable>.
                             <itemizedlist mark='bullet'>
                                 <listitem>
                                     <para><replaceable>pure</replaceable>, pure random choice, even among recently played track.
@@ -317,10 +316,6 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                                     <para><replaceable>sensible</replaceable>, use play history to filter chosen tracks.
                                     </para>
                                 </listitem>
-                                <listitem>
-                                    <para><replaceable>genre</replaceable>, Not implemented yet.
-                                    </para>
-                                </listitem>
                             </itemizedlist>
                         </para>
                     </listitem>
@@ -410,7 +405,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                             cache.<sbr />When set to "true", sima will use a
                             persistent cache for its http client. The cache is
                             written along with the dbfile in:<sbr />
-                            <filename>$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE</filename>.<sbr/>
+                            <filename>$XDG_DATA_HOME/mpd_sima/http/WEB_SERVICE</filename>.<sbr/>
                             If set to "false", caching is still done but in memory.
                         </para>
                     </listitem>
@@ -425,6 +420,52 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 </varlistentry>
             </variablelist>
         </refsect2>
+        <refsect2 id="genre">
+            <title>Genre section</title>
+            <para>Genre plugin's configuration.</para>
+            <para>This plugin permits offline autoqueuing based on files genre tag only.</para>
+            <para>It will try to queue tracks with similar genres (track's genre being read from tags).</para>
+                <varlistentry> <!-- genre -->
+                   <term><option>[genre]</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.queue_mode -->
+                    <term><option>queue_mode=</option><replaceable>track</replaceable></term>
+                    <listitem>
+                        <para>Queue mode to use among
+                            <replaceable>track</replaceable>,
+                            <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- genre.single_album -->
+                    <term><option>single_album=</option><replaceable>false</replaceable></term>
+                    <listitem>
+                        <para>Prevent from queueing a track from the same album
+                            (it often happens with OST).<sbr />
+                            Only relevant in "track" queue mode.</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- genre.priority -->
+                    <term><option>priority=</option><replaceable>80</replaceable></term>
+                    <listitem>
+                        <para>
+                            Plugin priority
+                        </para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- genre.track_to_add -->
+                    <term><option>track_to_add=</option><replaceable>1</replaceable></term>
+                    <listitem>
+                        <para>How many track(s) to add.</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- genre.album_to_add -->
+                    <term><option>album_to_add=</option><replaceable>1</replaceable></term>
+                    <listitem>
+                        <para>How many album(s) to add. Only relevant in
+                            <option>album</option> queue mode.</para>
+                    </listitem>
+                </varlistentry>
+        </refsect2>
         <refsect2 id="tags">
             <title>Tags section</title>
             <para>Tags plugin's configuration. There is no default configuration for this plugin,
@@ -456,6 +497,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                             <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
                     </listitem>
                 </varlistentry>
+                <varlistentry> <!-- tags.single_album -->
+                    <term><option>single_album=</option><replaceable>false</replaceable></term>
+                    <listitem>
+                        <para>Prevent from queueing a track from the same album
+                            (it often happens with OST).<sbr />
+                            Only relevant in "track" queue mode.</para>
+                    </listitem>
+                </varlistentry>
                 <varlistentry> <!-- tags.filter -->
                     <term><option>filter=</option></term>
                     <listitem>