Fixed Genre plugin documenation

[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 c790928a80dc8209ae9024cf8eefbc9eaef07171..360d5f4fc3c4fcdccbf45dbbc35f5c1e2dfb7625 100644 (file)
--- a/data/man/mpd_sima.cfg.5.xml
+++ b/data/man/mpd_sima.cfg.5.xml
@@ -425,22 +425,67 @@ 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 base on genre tags of tracks in the queue.</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,
               it does not work out of the box.</para>
-            <para>  This plugin permits offline autoqueuing based on files tags only. Supported tags are
+            <para>This plugin permits offline autoqueuing based on files tags only. Supported tags are
               <option>'comment'</option>, <option>'date'</option>, <option>'genre'</option>,
-              <option>'label'</option> and <option>'originaldate'</option>. It currently
-              supports single track queuing only, no album mode for this plugin.</para>
+              <option>'label'</option> and <option>'originaldate'</option>.</para>
             <para>In addition to supported tags above you can use an MPD filter. Please refer to
               MPD protocol documentation for more.</para>
-            <para>All entries in this section are ANDed as a single MPD filter to look for titles
-              in the library. Moreover, with tags, comma separated values are also ORed.<sbr />
+            <para>All tag entries in this section are ANDed as a single MPD filter to look for titles
+              in the library. Moreover, for each tags, comma separated values are also ORed.<sbr />
               For instance setting "<option>genre=rock</option>" and
               "<option>date=1982,1983,1984,1985,1986,1987,1988,1989</option>"
               will end up looking for track tagged with genre <option>rock</option>
-              and date within 1985 through 1990.<sbr />
+              and date within 1982 through 1989.<sbr />
               Using an MPD filter to replace <option>date</option> you can achieve
               the same with the following setting: "<option>genre=rock</option>" and
               "<option>filter=(date =~ '198[2-9]+')</option>" (provided your MPD server
@@ -449,6 +494,22 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- tags -->
                    <term><option>[tags]</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> <!-- 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>
@@ -467,6 +528,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- tags.label -->
                     <term><option>label=</option></term>
                 </varlistentry>
+                <varlistentry> <!-- tags.originaldate -->
+                    <term><option>originaldate=</option></term>
+                </varlistentry>
                 <varlistentry> <!-- tags.priority -->
                     <term><option>priority=</option><replaceable>80</replaceable></term>
                     <listitem>
@@ -481,6 +545,13 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                         <para>How many track(s) to add.</para>
                     </listitem>
                 </varlistentry>
+                <varlistentry> <!-- tags.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>
     </refsect1>
     <refsect1 id="queue_mode">