]> kaliko git repositories - mpd-sima.git/blobdiff - data/man/mpd_sima.cfg.5.xml
Fixed typo, thanks lintian
[mpd-sima.git] / data / man / mpd_sima.cfg.5.xml
index b6bd1237a9e2f1291a109fd9f435da11b5e04ce2..fca2263ddd90ebec6efdd9ec96afe64237b121b6 100644 (file)
@@ -139,7 +139,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>
@@ -185,62 +185,77 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                     <term><option>[sima]</option></term>
                     <listitem><para></para></listitem>
                 </varlistentry>
-                <varlistentry> <!-- sima.history_duration -->
-                    <term><option>history_duration=</option><replaceable>8</replaceable></term>
-                    <listitem>
-                        <para>How far to look back in history to avoid to play
-                            twice the same track/title (duration in
-                            hours).</para>
-                    </listitem>
-                </varlistentry>
-                <varlistentry> <!-- sima.queue_length -->
-                    <term><option>queue_length=</option><replaceable>1</replaceable></term>
-                    <listitem>
-                        <para>This value triggers queue process if the queue
-                            length is less than specified
-                            queue_length.</para>
-                    </listitem>
-                </varlistentry>
-                <varlistentry> <!-- sima.musicbrainzid -->
-                    <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
-                    <listitem>
-                        <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>
-            <para>&dhpackage;'s plugin management for internal source plugin
-                and contrib (ie. external plugins).<sbr /> Plugins list is a
-                comma separated string list.<sbr /> Optional plugin's
-                configuration lays in its own section.<sbr />For instance a
-                "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
-                plugin, ie.  Random → random.
-            </para>
-            <variablelist>
-                <varlistentry> <!-- sima.internal -->
-                    <term><option>internal=</option><replaceable>Crop, Random, Lastfm</replaceable></term>
-                    <listitem>
-                        <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
-                            <option>LastFm</option> with <option>EchoNest</option> to try.</para>
-                    </listitem>
-                </varlistentry>
-                <varlistentry> <!-- sima.contrib -->
-                    <term><option>contrib=</option><replaceable></replaceable></term>
-                    <listitem>
-                        <para></para>
-                    </listitem>
-                </varlistentry>
+                <variablelist>
+                    <varlistentry> <!-- sima.contrib -->
+                        <term><option>contrib=</option><replaceable></replaceable></term>
+                        <listitem>
+                            <para></para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.internal -->
+                        <term><option>internal=</option><replaceable>Lastfm, Random, Crop</replaceable></term>
+                        <listitem>
+                            <para>&dhpackage;'s plugin management for internal source plugin
+                                and contrib (ie. external plugins).<sbr /> Plugins list is a
+                                comma separated string list.<sbr /> Optional plugin's
+                                configuration lays in its own section.<sbr />For instance a
+                                "AwesomePlugin" declared here gets its configuration from the
+                                corresponding section "[awesomeplugin]".
+                            </para>
+                            <para>The default list of plugins to load at startup: <option>Lastfm</option>,<option>Random</option>,<option>Crop</option>.<sbr />
+                                <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 />
+                                The priority may be used to order them.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.history_duration -->
+                        <term><option>history_duration=</option><replaceable>8</replaceable></term>
+                        <listitem>
+                            <para>How far to look back in history to avoid to play
+                                twice the same track/title (duration in
+                                hours).<sbr />
+                                The <option>history_duration</option> is also used to give priority to not recently played artists.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.queue_length -->
+                        <term><option>queue_length=</option><replaceable>2</replaceable></term>
+                        <listitem>
+                            <para>Threshold value triggering queue process.</para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.musicbrainzid -->
+                        <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
+                        <listitem>
+                            <para>Use MusicBrainzIdentifier to search music (mainly
+                                for artists).
+                                Default is True, switch to False if you don't have
+                                MusicBrainzIdentifier set for at least 80% of you
+                                music library.<sbr /> Consider using these metadata as it
+                                enhances a lot artist/album/tracks identification.
+                                Use Picard to tag your file: <ulink url="https://picard.musicbrainz.org/"/>.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.repeat_disable_queue -->
+                        <term><option>repeat_disable_queue=</option><replaceable>true</replaceable></term>
+                        <listitem>
+                            <para>Prevent disabling queuing in repeat play mode.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                    <varlistentry> <!-- sima.single_disable_queue -->
+                        <term><option>single_disable_queue=</option><replaceable>true</replaceable></term>
+                        <listitem>
+                            <para>Prevent disabling queuing in single play mode.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                </variablelist>
             </variablelist>
         </refsect2>
         <refsect2 id="crop">
@@ -250,11 +265,19 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                     <term><option>[crop]</option></term>
                 </varlistentry>
                 <varlistentry> <!-- crop.consume -->
-                    <term><option>consume=</option><replaceable>0</replaceable></term>
+                    <term><option>consume=</option><replaceable>10</replaceable></term>
                     <listitem>
                         <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.
+                            Set to some negative integer to keep all played tracks.
+                        </para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry> <!-- crop.priority -->
+                    <term><option>priority=</option><replaceable>10</replaceable></term>
+                    <listitem>
+                        <para>
+                            Plugin priority
                         </para>
                     </listitem>
                 </varlistentry>
@@ -291,6 +314,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                         </para>
                     </listitem>
                 </varlistentry>
+                <varlistentry> <!-- random.priority -->
+                    <term><option>priority=</option><replaceable>50</replaceable></term>
+                    <listitem>
+                        <para>
+                            Plugin priority
+                        </para>
+                    </listitem>
+                </varlistentry>
         </refsect2>
         <refsect2 id="lastfm">
             <title>LastFm section</title>
@@ -363,6 +394,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                         </para>
                     </listitem>
                 </varlistentry>
+                <varlistentry> <!-- lastfm.priority -->
+                    <term><option>priority=</option><replaceable>100</replaceable></term>
+                    <listitem>
+                        <para>
+                            Plugin priority
+                        </para>
+                    </listitem>
+                </varlistentry>
             </variablelist>
         </refsect2>
     </refsect1>
@@ -409,10 +448,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                         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.<sbr />
-                        It is planned to allow users to set the values of
-                        AlbumArtists tag triggering this behaviour.  cf.
-                        feature request #2085 on the tracker.</para>
+                        is skipped and won't be queued.</para>
                 </listitem>
             </varlistentry>
         </variablelist>