X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5.xml;h=153448c1eece19d6862ca001f07e6144c3adb0cd;hb=745a6802fd6a8f64f0e7b8b13f88db50a87648e6;hp=002b1413a635796a9001356ea6746faa4b9d12b5;hpb=41e7f45be3c35a4630478211b2036ce496fdf588;p=mpd-sima.git

diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml
index 002b141..153448c 100644
--- a/data/man/mpd_sima.cfg.5.xml
+++ b/data/man/mpd_sima.cfg.5.xml
@@ -75,9 +75,15 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
             <para></para>
             <para></para>
         </refsect2> -->
+        <refsect2 id="tags">
+            <title>File tags queue mode (offline mode).</title>
+            <para>Here is an example of autoqueue using file tags only.</para>
+            <programlisting><xi:include href="tags.cfg" parse="text" />
+            </programlisting>
+        </refsect2>
         <refsect2 id="album">
-            <title>Album queue mode.</title>
-            <para>Here is an example of album queue configuration.</para>
+            <title>Album queue mode using last.fm recommendations (online mode).</title>
+            <para>Here is an example of album queue configuration using online recommendations system.</para>
             <programlisting><xi:include href="album.cfg" parse="text" />
             </programlisting>
         </refsect2>
@@ -139,7 +145,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- log.logfile -->
                     <term><option>logfile=</option></term>
                     <listitem>
-                        <para>File to log to, usually in dæmon mode.<sbr />Defaut
+                        <para>File to log to, usually in dæmon mode.<sbr />Default
                             (empty or unset) is to log to stdin/stdout.</para>
                     </listitem>
                 </varlistentry>
@@ -206,8 +212,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                                 <option>Crop</option> is an utility plugin, it does not queue any tracks (cf. below).<sbr />
                                 <option>Random</option> will queue a track at random if other plugins did not return any tracks.<sbr />
                             </para>
-                            <para>You can add here as many plugins you want,
-                                currently shipping <option>Lastfm</option> only.<sbr />
+                            <para>You can add, combine here as many plugins you want.<sbr />
                                 The priority may be used to order them.
                             </para>
                         </listitem>
@@ -288,6 +293,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- random -->
                     <term><option>[random]</option></term>
                 </varlistentry>
+                <varlistentry> <!-- random.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> <!-- random.flavour -->
                     <term><option>flavour=</option><replaceable>sensible</replaceable></term>
                     <listitem>
@@ -342,7 +353,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- lastfm.max_art -->
                     <term><option>max_art=</option><replaceable>10</replaceable></term>
                     <listitem>
-                        <para>Number of similar artist to retrieve from local
+                        <para>Maximum number of similar artist to retrieve from local
                             media library.<sbr />When set to something superior
                             to zero, it tries to get as much similar artists
                             from media library.</para>
@@ -372,7 +383,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                     <listitem>
                         <para>How many track(s) to add. Only relevant in
                             <option>top</option> and <option>track</option>
-                            queue modes.</para>
+                            queue modes. This is actually an upper limit,
+                            min(<option>max_art</option>,
+                            <option>track_to_add</option>) will be used.</para>
                     </listitem>
                 </varlistentry>
                 <varlistentry> <!-- lastfm.album_to_add -->
@@ -382,6 +395,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                             <option>album</option> queue modes.</para>
                     </listitem>
                 </varlistentry>
+                <varlistentry> <!-- lastfm.track_to_add_from_album -->
+                    <term><option>track_to_add_from_album=</option><replaceable>0</replaceable></term>
+                    <listitem>
+                        <para>How many track(s) to add from each selected albums. Only relevant in
+                          <option>album</option> queue modes. When set to 0 or lower the whole album is queued.
+                          </para>
+                    </listitem>
+                </varlistentry>
                 <varlistentry> <!-- lastfm.cache -->
                     <term><option>cache=</option><replaceable>True</replaceable></term>
                     <listitem>
@@ -404,15 +425,73 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 </varlistentry>
             </variablelist>
         </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
+              <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>
+            <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 ANDed.<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 />
+              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
+              was compiled with libpcre).
+            </para>
+                <varlistentry> <!-- tags -->
+                   <term><option>[tags]</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.filter -->
+                    <term><option>filter=</option></term>
+                    <listitem>
+                        <para>You can use here any valid MPD filter as defined in MPD protocol documentation.</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- tags.comment -->
+                    <term><option>comment=</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.date -->
+                    <term><option>date=</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.genre -->
+                    <term><option>genre=</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.label -->
+                    <term><option>label=</option></term>
+                </varlistentry>
+                <varlistentry> <!-- tags.priority -->
+                    <term><option>priority=</option><replaceable>80</replaceable></term>
+                    <listitem>
+                        <para>
+                            Plugin priority
+                        </para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- tags.track_to_add -->
+                    <term><option>track_to_add=</option><replaceable>1</replaceable></term>
+                    <listitem>
+                        <para>How many track(s) to add.</para>
+                    </listitem>
+                </varlistentry>
+        </refsect2>
     </refsect1>
     <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 last track in the queue.</para>
+        <para>Different queue modes are available with some plugins (check for
+        <option>queue_mode</option> presence in plugin config).
+        </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
-            tracks.</para>
+        at least not recently played artist.</para>
         <variablelist>
             <varlistentry>
                 <term><option>track</option></term>
@@ -457,3 +536,5 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
   <xi:include href="feedback.xml" />
   <xi:include href="seealso.xml" />
 </refentry>
+<!-- vim: tabstop=4 softtabstop=4 shiftwidth=4 :
+-->