1 <?xml version='1.0' encoding='UTF-8'?>
5 -''-param man.charmap.use.subset "0" \
6 -''-param make.year.ranges "1" \
7 -''-param make.single.year.ranges "1" \
8 /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
11 A manual page <package>.<section> will be generated. You may view the
12 manual page with: nroff -man <package>.<section> | less'. A typical entry
13 in a Makefile or Makefile.am is:
15 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
16 XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
18 manpage.1: manpage.xml
21 The xsltproc binary is found in the xsltproc package. The XSL files are in
22 docbook-xsl. A description of the parameters you can use can be found in the
23 docbook-xsl-doc-* packages. Please remember that if you create the nroff
24 version in one of the debian/rules file targets (such as build), you will need
25 to include xsltproc and docbook-xsl in your Build-Depends control field.
26 Alternatively use the xmlto command/package. That will also automatically
27 pull in xsltproc and docbook-xsl.
29 Notes for using docbook2x: docbook2x-man does not automatically create the
30 AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
31 <refsect1> ... </refsect1>.
33 To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
34 read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
35 found in the docbook-xsl-doc-html package.
37 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
39 General documentation about man-pages and man-page-formatting:
40 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
45 <!ENTITY dhsection "5">
46 <!ENTITY dhpackage "mpd-sima">
47 <!ENTITY dhutils "mpd_sima.cfg">
51 <refentry xmlns="http://docbook.org/ns/docbook"
52 xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
53 <xi:include href="info.xml" />
55 <refentrytitle>&dhutils;</refentrytitle>
56 <manvolnum>&dhsection;</manvolnum>
59 <refname>&dhutils;</refname>
60 <refpurpose>&dhpackage; will try to maintain some titles ahead in the queue
61 following different policies. This manual document the
62 configuration file for &dhpackage;.</refpurpose>
64 <refsect1 id="description">
65 <title>DESCRIPTION</title>
66 <para>This manual page documents briefly <command>&dhpackage;</command>
67 configuration options available in user configuration file
68 (see <xref linkend="files"/>).</para>
70 <refsect1 id="examples">
71 <title>EXAMPLES</title>
74 <title>Default queue mode, similar artist.</title>
79 <title>Album queue mode.</title>
80 <para>Here is an example of album queue configuration.</para>
81 <programlisting><xi:include href="album.cfg" parse="text" />
86 <refsect1 id="options">
87 <title>Configuration file</title>
88 <para>The configuration file consists of sections, led by a
89 <command>[section]</command> header and followed by <option>name: value</option>
90 entries, with continuations in the style of RFC 822 (see section
91 3.1.1, “LONG HEADER FIELDS”); <option>name=value</option> is also accepted. Lines
92 beginning with <parameter>'#'</parameter> or <parameter>';'</parameter>
93 are ignored and may be used to provide comments (<emphasis>Nota
94 Bene:</emphasis> inline comment are possible using <parameter>'#'</parameter>).</para>
95 <title>OPTIONS</title>
96 <para>The default values are used in the options lists below.</para>
98 <title>MPD section</title>
99 <para>This section is meant to configure MPD access, MPD host
100 address / port and password if necessary.</para>
102 <!-- Use the variablelist.term.separator and the
103 variablelist.term.break.after parameters to
104 control the term elements. -->
105 <varlistentry> <!-- MPD -->
106 <term><option>[MPD]</option></term>
107 <listitem></listitem>
109 <varlistentry> <!-- MPD.host -->
110 <term><option>host=</option><replaceable>localhost</replaceable></term>
112 <para>Set MPD host. Use IP or FQDN.</para>
115 <varlistentry> <!-- MPD.port -->
116 <term><option>port=</option><replaceable>6600</replaceable></term>
118 <para>Set host port to access MPD to.</para>
121 <varlistentry> <!-- MPD.password -->
122 <term><option>password=</option><replaceable>s3cr3t</replaceable></term>
124 <para>Set MPD password to use. Do not use this option
125 if you don't have enabled password protected access
126 on your MPD server.</para>
132 <title>log section</title>
133 <para>Configure logging.</para>
135 <varlistentry> <!-- LOG -->
136 <term><option>[log]</option></term>
137 <listitem><para></para></listitem>
139 <varlistentry> <!-- log.logfile -->
140 <term><option>logfile=</option></term>
142 <para>File to log to, usually in dæmon mode.<sbr />Defaut
143 (empty or unset) is to log to stdin/stdout.</para>
146 <varlistentry> <!-- log.verbosity -->
147 <term><option>verbosity=</option><replaceable>info</replaceable></term>
149 <para>Logging verbosity among
150 <replaceable>debug</replaceable>,
151 <replaceable>info</replaceable>,
152 <replaceable>warning</replaceable>,
153 <replaceable>error</replaceable>.</para>
158 <refsect2 id="daemon">
159 <title>Process daemonization</title>
160 <para>Configure process daemon.</para>
162 <varlistentry> <!-- DAEMON -->
163 <term><option>[daemon]</option></term>
164 <listitem><para></para></listitem>
166 <varlistentry> <!-- daemon.daemon -->
167 <term><option>daemon=false</option></term>
169 <para>whether to daemonize process or not.</para>
172 <varlistentry> <!-- daemon.pidfile -->
173 <term><option>pidfile=</option></term>
175 <para>Where to store process ID.</para>
181 <title>sima section</title>
182 <para>Core &dhutils; configuration.</para>
184 <varlistentry> <!-- SIMA -->
185 <term><option>[sima]</option></term>
186 <listitem><para></para></listitem>
188 <varlistentry> <!-- sima.history_duration -->
189 <term><option>history_duration=</option><replaceable>8</replaceable></term>
191 <para>How far to look back in history to avoid to play
192 twice the same track/title (duration in
196 <varlistentry> <!-- sima.queue_length -->
197 <term><option>queue_length=</option><replaceable>1</replaceable></term>
199 <para>This value triggers queue process if the queue
200 length is less than specified
204 <varlistentry> <!-- sima.musicbrainzid -->
205 <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
207 <para>Use MusicBrainzIdentifier to search music (mainly
208 for artists). Consider using these metadata as it
209 enhances a lot artist/album/tracks identification.<sbr />
210 Default is True, switch to False if you don't have
211 MusicBrainzIdentifier set for at least 80% of you
212 music library.<sbr />
213 Use Picard to tag your file: <ulink url="https://picard.musicbrainz.org/"/>.
218 <para>&dhpackage;'s plugin management for internal source plugin
219 and contrib (ie. external plugins).<sbr /> Plugins list is a
220 comma separated string list.<sbr /> Optional plugin's
221 configuration lays in its own section.<sbr />For instance a
222 "AwesomePlugin" declared here gets its configuration from the
223 corresponding section "[awesomeplugin]".<sbr />internal plugins
224 will look for a section named after the lower-cased name of the
225 plugin, ie. Random → random.
228 <varlistentry> <!-- sima.internal -->
229 <term><option>internal=</option><replaceable>Crop, Random, Lastfm</replaceable></term>
231 <para><option>Crop</option> and <option>Random</option>
232 are utilities plugins while <option>Lastfm</option> is the
233 actual queue plugin.<sbr /> Another queue plugin is available as
234 a "techno preview", it relies on EchoNest web services, replace
235 <option>LastFm</option> with <option>EchoNest</option> to try.</para>
238 <varlistentry> <!-- sima.contrib -->
239 <term><option>contrib=</option><replaceable></replaceable></term>
247 <title>Crop section</title>
248 <para>crop plugin's configuration:</para>
249 <varlistentry> <!-- crop -->
250 <term><option>[crop]</option></term>
252 <varlistentry> <!-- crop.consume -->
253 <term><option>consume=</option><replaceable>0</replaceable></term>
255 <para>How many played tracks to keep in the queue.
256 Allows you to maintain a fixed length queue.
257 Set to 0 to keep all played tracks.
262 <refsect2 id="random">
263 <title>Random section</title>
264 <para>Random plugin's configuration:</para>
265 <varlistentry> <!-- random -->
266 <term><option>[random]</option></term>
268 <varlistentry> <!-- random.flavour -->
269 <term><option>flavour=</option><replaceable>sensible</replaceable></term>
271 <para>When no similar tracks are found, falling back to
272 random queuing. Different mode, aka random flavour,
274 <replaceable>pure</replaceable>,
275 <replaceable>sensible</replaceable>,
276 <replaceable>genre</replaceable>.
277 <itemizedlist mark='bullet'>
279 <para><replaceable>pure</replaceable>, pure random choice, even among recently played track.
283 <para><replaceable>sensible</replaceable>, use play history to filter chosen tracks.
287 <para><replaceable>genre</replaceable>, Not implemented yet.
295 <refsect2 id="lastfm">
296 <title>LastFm section</title>
297 <para>LastFM plugin's configuration.</para>
299 <varlistentry> <!-- lastfm -->
300 <term><option>[lastfm]</option></term>
302 <varlistentry> <!-- lastfm.queue_mode -->
303 <term><option>queue_mode=</option><replaceable>track</replaceable></term>
305 <para>Queue mode to use among
306 <replaceable>track</replaceable>,
307 <replaceable>top</replaceable> and
308 <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
311 <varlistentry> <!-- lastfm.max_art -->
312 <term><option>max_art=</option><replaceable>10</replaceable></term>
314 <para>Number of similar artist to retrieve from local
315 media library.<sbr />When set to something superior
316 to zero, it tries to get as much similar artists
317 from media library.</para>
320 <varlistentry> <!-- lastfm.depth -->
321 <term><option>depth=</option><replaceable>1</replaceable></term>
323 <para>How many artists to base on similar artists
324 search.<sbr /> The first is the last played artist
325 and so on back in the history. Highter depth
326 generates wider suggestions, it might help to
327 reduce looping over same artists.
331 <varlistentry> <!-- lastfm.single_album -->
332 <term><option>single_album=</option><replaceable>false</replaceable></term>
334 <para>Prevent from queueing a track from the same album
335 (it often happens with OST).<sbr />
336 Only relevant in "track" queue mode.</para>
339 <varlistentry> <!-- lastfm.track_to_add -->
340 <term><option>track_to_add=</option><replaceable>1</replaceable></term>
342 <para>How many track(s) to add. Only relevant in
343 <option>top</option> and <option>track</option>
347 <varlistentry> <!-- lastfm.album_to_add -->
348 <term><option>album_to_add=</option><replaceable>1</replaceable></term>
350 <para>How many album(s) to add. Only relevant in
351 <option>album</option> queue modes.</para>
354 <varlistentry> <!-- lastfm.cache -->
355 <term><option>cache=</option><replaceable>True</replaceable></term>
357 <para>Whether or not to use on-disk persistent http
358 cache.<sbr />When set to "true", sima will use a
359 persistent cache for its http client. The cache is
360 written along with the dbfile in:<sbr />
361 <filename>$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE</filename>.<sbr/>
362 If set to "false", caching is still done but in memory.
369 <refsect1 id="queue_mode">
370 <title>QUEUE MODES</title>
371 <para>&dhpackage; offers different queue modes. All of them pick up
372 tracks from artists similar to the last track in the queue.</para>
373 <para>&dhpackage; tries preferably to chose among unplayed artists or
374 at least not recently played artist. Concerning track and album
375 queue modes titles are chosen purely at random among unplayed
379 <term><option>track</option></term>
381 <para>Queue a similar track chosen at random from a similar artist.</para>
385 <term><option>top</option></term>
387 <para>Queue a track from a similar artist, chosen among
388 "top tracks" according to last.fm data mining.</para>
392 <term><option>album</option></term>
394 <para>Queue a whole album chosen at random from a similar artist.</para>
395 <para><emphasis>Nota Bene:</emphasis><sbr /> Due to the
396 track point of view of database build upon tracks tags
397 an album lookup for a specific artist will return
398 albums as soon as this artist appears in a single track
400 For instance looking for album from "The Velvet
401 Underground" will fetch "Last Days" and "Juno" OSTs
402 because the band appears on the soundtrack of these two
404 A solution is for you to set AlbumArtists tag to
405 something different than the actual artist of the
406 track. For compilations, OSTs etc. a strong convention
407 is to use "Various Artists" for this tag.</para>
408 <para>&dhpackage; is currently looking for AlbumArtists tags
409 and avoid album where this tag is set with "Various
410 Artists". If a single track within an album is found
411 with AlbumArtists:"Various Artists" the complete album
412 is skipped and won't be queued.<sbr />
413 It is planned to allow users to set the values of
414 AlbumArtists tag triggering this behaviour. cf.
415 feature request #2085 on the tracker.</para>
420 <xi:include href="files.xml" />
421 <xi:include href="feedback.xml" />
422 <xi:include href="seealso.xml" />