]> kaliko git repositories - mpd-sima.git/blobdiff - data/man/mpd_sima.cfg.5.xml
Releasing 0.16.0
[mpd-sima.git] / data / man / mpd_sima.cfg.5.xml
index 8481c4cf313b89bfb905fa26b460b9e47c13aade..149087f8a2a36243215ba6e2903e0b887d578afb 100644 (file)
@@ -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>
@@ -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>
@@ -374,9 +385,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                             <option>top</option> and <option>track</option>
                             queue modes. This is actually an upper limit,
                             min(<option>max_art</option>,
-                            <option>track_to_add</option>) will be used, and
-                            <option>max_art</option> might be inferior lower
-                            than value set in config.</para>
+                            <option>track_to_add</option>) will be used.</para>
                     </listitem>
                 </varlistentry>
                 <varlistentry> <!-- lastfm.album_to_add -->
@@ -386,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>
@@ -408,56 +425,116 @@ 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>
-                <listitem>
-                    <para>Queue a similar track chosen at random from a similar artist.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term><option>top</option></term>
-                <listitem>
-                    <para>Queue a track from a similar artist, chosen among
-                        "top tracks" according to last.fm data mining.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term><option>album</option></term>
-                <listitem>
-                    <para>Queue a whole album chosen at random from a similar artist.</para>
-                    <para><emphasis>Nota Bene:</emphasis><sbr /> Due to the
-                        track point of view of database build upon tracks tags
-                        an album lookup for a specific artist will return
-                        albums as soon as this artist appears in a single track
-                        of the album.<sbr />
-                        For instance looking for album from "The Velvet
-                        Underground" will fetch "Last Days" and "Juno" OSTs
-                        because the band appears on the soundtrack of these two
-                        movies.<sbr />
-                        A solution is for you to set AlbumArtists tag to
-                        something different than the actual artist of the
-                        track. For compilations, OSTs etc. a strong convention
-                        is to use "Various Artists" for this tag.</para>
-                    <para>&dhpackage; is currently looking for AlbumArtists tags
-                        and avoid album where this tag is set with "Various
-                        Artists". If a single track within an album is found
-                        with AlbumArtists:"Various Artists" the complete album
-                        is skipped and won't be queued.</para>
-                </listitem>
-            </varlistentry>
+          <varlistentry>
+            <term><option>track</option></term>
+            <listitem>
+              <para>Queue a similar track chosen at random from a similar artist.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>top</option></term>
+            <listitem>
+              <para>Queue a track from a similar artist, chosen among
+                "top tracks" according to last.fm data mining.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>album</option></term>
+            <listitem>
+              <para>Queue a whole album chosen at random from a similar artist.</para>
+              <para><emphasis>Nota Bene:</emphasis><sbr /> Due to the
+                track point of view of database build upon tracks tags
+                an album lookup for a specific artist will return
+                albums as soon as this artist appears in a single track
+                of the album.<sbr />
+                For instance looking for album from "The Velvet
+                Underground" will fetch "Last Days" and "Juno" OSTs
+                because the band appears on the soundtrack of these two
+                movies.<sbr />
+                A solution is for you to set AlbumArtists tag to
+                something different than the actual artist of the
+                track. For compilations, OSTs etc. a strong convention
+                is to use "Various Artists" for this tag.</para>
+              <para>&dhpackage; is currently looking for AlbumArtists tags
+                and avoid album where this tag is set with "Various
+                Artists". If a single track within an album is found
+                with AlbumArtists:"Various Artists" the complete album
+                is skipped and won't be queued.</para>
+            </listitem>
+          </varlistentry>
         </variablelist>
     </refsect1>
   <xi:include href="files.xml" />
   <xi:include href="feedback.xml" />
   <xi:include href="seealso.xml" />
 </refentry>
+<!-- vim: tabstop=4 softtabstop=4 shiftwidth=4 :
+-->