]> kaliko git repositories - mpd-sima.git/blob - data/man/mpd_sima.cfg.5.xml
Fixed code smell
[mpd-sima.git] / data / man / mpd_sima.cfg.5.xml
1 <?xml version='1.0' encoding='UTF-8'?>
2 <!--
3
4 `xsltproc -''-nonet \
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 \
9           manpage.xml'
10
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:
14
15 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
16 XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
17
18 manpage.1: manpage.xml
19         $(XP) $(DB2MAN) $<
20
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.
28
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>.
32
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.
36
37 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
38
39 General documentation about man-pages and man-page-formatting:
40 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
41
42 -->
43 <!DOCTYPE refentry [
44
45   <!ENTITY dhsection   "5">
46   <!ENTITY dhpackage "mpd-sima">
47   <!ENTITY dhutils "mpd_sima.cfg">
48
49 ]>
50
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" />
54   <refmeta>
55       <refentrytitle>&dhutils;</refentrytitle>
56       <manvolnum>&dhsection;</manvolnum>
57   </refmeta>
58     <refnamediv>
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>
63     </refnamediv>
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>
69     </refsect1>
70     <refsect1 id="examples">
71         <title>EXAMPLES</title>
72         <!--
73         <refsect2 id="track">
74             <title>Default queue mode, similar artist.</title>
75             <para></para>
76             <para></para>
77         </refsect2> -->
78         <refsect2 id="album">
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" />
82             </programlisting>
83         </refsect2>
84     </refsect1>
85
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>
97         <refsect2 id="MPD">
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>
101             <variablelist>
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>
108                 </varlistentry>
109                 <varlistentry> <!-- MPD.host -->
110                     <term><option>host=</option><replaceable>localhost</replaceable></term>
111                     <listitem>
112                         <para>Set MPD host. Use IP or FQDN.</para>
113                     </listitem>
114                 </varlistentry>
115                 <varlistentry> <!-- MPD.port -->
116                     <term><option>port=</option><replaceable>6600</replaceable></term>
117                     <listitem>
118                         <para>Set host port to access MPD to.</para>
119                     </listitem>
120                 </varlistentry>
121                 <varlistentry> <!-- MPD.password -->
122                     <term><option>password=</option><replaceable>s3cr3t</replaceable></term>
123                     <listitem>
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>
127                     </listitem>
128                 </varlistentry>
129             </variablelist>
130         </refsect2>
131         <refsect2 id="log">
132             <title>log section</title>
133             <para>Configure logging.</para>
134             <variablelist>
135                 <varlistentry> <!-- LOG -->
136                     <term><option>[log]</option></term>
137                     <listitem><para></para></listitem>
138                 </varlistentry>
139                 <varlistentry> <!-- log.logfile -->
140                     <term><option>logfile=</option></term>
141                     <listitem>
142                         <para>File to log to, usually in dæmon mode.<sbr />Default
143                             (empty or unset) is to log to stdin/stdout.</para>
144                     </listitem>
145                 </varlistentry>
146                 <varlistentry> <!-- log.verbosity -->
147                     <term><option>verbosity=</option><replaceable>info</replaceable></term>
148                     <listitem>
149                         <para>Logging verbosity among
150                             <replaceable>debug</replaceable>,
151                             <replaceable>info</replaceable>,
152                             <replaceable>warning</replaceable>,
153                             <replaceable>error</replaceable>.</para>
154                     </listitem>
155                 </varlistentry>
156             </variablelist>
157         </refsect2>
158         <refsect2 id="daemon">
159             <title>Process daemonization</title>
160             <para>Configure process daemon.</para>
161             <variablelist>
162                 <varlistentry> <!-- DAEMON -->
163                     <term><option>[daemon]</option></term>
164                     <listitem><para></para></listitem>
165                 </varlistentry>
166                 <varlistentry> <!-- daemon.daemon -->
167                     <term><option>daemon=false</option></term>
168                     <listitem>
169                         <para>whether to daemonize process or not.</para>
170                     </listitem>
171                 </varlistentry>
172                 <varlistentry> <!-- daemon.pidfile -->
173                     <term><option>pidfile=</option></term>
174                     <listitem>
175                         <para>Where to store process ID.</para>
176                     </listitem>
177                 </varlistentry>
178             </variablelist>
179         </refsect2>
180         <refsect2 id="sima">
181             <title>sima section</title>
182             <para>Core &dhutils; configuration.</para>
183             <variablelist>
184                 <varlistentry> <!-- SIMA -->
185                     <term><option>[sima]</option></term>
186                     <listitem><para></para></listitem>
187                 </varlistentry>
188                 <variablelist>
189                     <varlistentry> <!-- sima.contrib -->
190                         <term><option>contrib=</option><replaceable></replaceable></term>
191                         <listitem>
192                             <para></para>
193                         </listitem>
194                     </varlistentry>
195                     <varlistentry> <!-- sima.internal -->
196                         <term><option>internal=</option><replaceable>Lastfm, Random, Crop</replaceable></term>
197                         <listitem>
198                             <para>&dhpackage;'s plugin management for internal source plugin
199                                 and contrib (ie. external plugins).<sbr /> Plugins list is a
200                                 comma separated string list.<sbr /> Optional plugin's
201                                 configuration lays in its own section.<sbr />For instance a
202                                 "AwesomePlugin" declared here gets its configuration from the
203                                 corresponding section "[awesomeplugin]".
204                             </para>
205                             <para>The default list of plugins to load at startup: <option>Lastfm</option>,<option>Random</option>,<option>Crop</option>.<sbr />
206                                 <option>Crop</option> is an utility plugin, it does not queue any tracks (cf. below).<sbr />
207                                 <option>Random</option> will queue a track at random if other plugins did not return any tracks.<sbr />
208                             </para>
209                             <para>You can add here as many plugins you want,
210                                 currently shipping <option>Lastfm</option> only.<sbr />
211                                 The priority may be used to order them.
212                             </para>
213                         </listitem>
214                     </varlistentry>
215                     <varlistentry> <!-- sima.history_duration -->
216                         <term><option>history_duration=</option><replaceable>8</replaceable></term>
217                         <listitem>
218                             <para>How far to look back in history to avoid to play
219                                 twice the same track/title (duration in
220                                 hours).<sbr />
221                                 The <option>history_duration</option> is also used to give priority to not recently played artists.
222                             </para>
223                         </listitem>
224                     </varlistentry>
225                     <varlistentry> <!-- sima.queue_length -->
226                         <term><option>queue_length=</option><replaceable>2</replaceable></term>
227                         <listitem>
228                             <para>Threshold value triggering queue process.</para>
229                         </listitem>
230                     </varlistentry>
231                     <varlistentry> <!-- sima.musicbrainzid -->
232                         <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
233                         <listitem>
234                             <para>Use MusicBrainzIdentifier to search music (mainly
235                                 for artists).
236                                 Default is True, switch to False if you don't have
237                                 MusicBrainzIdentifier set for at least 80% of you
238                                 music library.<sbr /> Consider using these metadata as it
239                                 enhances a lot artist/album/tracks identification.
240                                 Use Picard to tag your file: <ulink url="https://picard.musicbrainz.org/"/>.
241                             </para>
242                         </listitem>
243                     </varlistentry>
244                     <varlistentry> <!-- sima.repeat_disable_queue -->
245                         <term><option>repeat_disable_queue=</option><replaceable>true</replaceable></term>
246                         <listitem>
247                             <para>Prevent disabling queuing in repeat play mode.
248                             </para>
249                         </listitem>
250                     </varlistentry>
251                     <varlistentry> <!-- sima.single_disable_queue -->
252                         <term><option>single_disable_queue=</option><replaceable>true</replaceable></term>
253                         <listitem>
254                             <para>Prevent disabling queuing in single play mode.
255                             </para>
256                         </listitem>
257                     </varlistentry>
258                 </variablelist>
259             </variablelist>
260         </refsect2>
261         <refsect2 id="crop">
262             <title>Crop section</title>
263             <para>crop plugin's configuration:</para>
264                 <varlistentry> <!-- crop -->
265                     <term><option>[crop]</option></term>
266                 </varlistentry>
267                 <varlistentry> <!-- crop.consume -->
268                     <term><option>consume=</option><replaceable>10</replaceable></term>
269                     <listitem>
270                         <para>How many played tracks to keep in the queue.
271                             Allows you to maintain a fixed length queue.
272                             Set to some negative integer to keep all played tracks.
273                         </para>
274                     </listitem>
275                 </varlistentry>
276                 <varlistentry> <!-- crop.priority -->
277                     <term><option>priority=</option><replaceable>10</replaceable></term>
278                     <listitem>
279                         <para>
280                             Plugin priority
281                         </para>
282                     </listitem>
283                 </varlistentry>
284         </refsect2>
285         <refsect2 id="random">
286             <title>Random section</title>
287             <para>Random plugin's configuration:</para>
288                 <varlistentry> <!-- random -->
289                     <term><option>[random]</option></term>
290                 </varlistentry>
291                 <varlistentry> <!-- random.flavour -->
292                     <term><option>flavour=</option><replaceable>sensible</replaceable></term>
293                     <listitem>
294                         <para>When no similar tracks are found, falling back to
295                             random queuing. Different mode, aka random flavour,
296                             are available:
297                             <replaceable>pure</replaceable>,
298                             <replaceable>sensible</replaceable>,
299                             <replaceable>genre</replaceable>.
300                             <itemizedlist mark='bullet'>
301                                 <listitem>
302                                     <para><replaceable>pure</replaceable>, pure random choice, even among recently played track.
303                                     </para>
304                                 </listitem>
305                                 <listitem >
306                                     <para><replaceable>sensible</replaceable>, use play history to filter chosen tracks.
307                                     </para>
308                                 </listitem>
309                                 <listitem>
310                                     <para><replaceable>genre</replaceable>, Not implemented yet.
311                                     </para>
312                                 </listitem>
313                             </itemizedlist>
314                         </para>
315                     </listitem>
316                 </varlistentry>
317                 <varlistentry> <!-- random.priority -->
318                     <term><option>priority=</option><replaceable>50</replaceable></term>
319                     <listitem>
320                         <para>
321                             Plugin priority
322                         </para>
323                     </listitem>
324                 </varlistentry>
325         </refsect2>
326         <refsect2 id="lastfm">
327             <title>LastFm section</title>
328             <para>LastFM plugin's configuration.</para>
329             <variablelist>
330                 <varlistentry> <!-- lastfm -->
331                     <term><option>[lastfm]</option></term>
332                 </varlistentry>
333                 <varlistentry> <!-- lastfm.queue_mode -->
334                     <term><option>queue_mode=</option><replaceable>track</replaceable></term>
335                     <listitem>
336                         <para>Queue mode to use among
337                             <replaceable>track</replaceable>,
338                             <replaceable>top</replaceable> and
339                             <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
340                     </listitem>
341                 </varlistentry>
342                 <varlistentry> <!-- lastfm.max_art -->
343                     <term><option>max_art=</option><replaceable>10</replaceable></term>
344                     <listitem>
345                         <para>Maximum number of similar artist to retrieve from local
346                             media library.<sbr />When set to something superior
347                             to zero, it tries to get as much similar artists
348                             from media library.</para>
349                     </listitem>
350                 </varlistentry>
351                 <varlistentry> <!-- lastfm.depth -->
352                     <term><option>depth=</option><replaceable>1</replaceable></term>
353                     <listitem>
354                         <para>How many artists to base on similar artists
355                             search.<sbr /> The first is the last played artist
356                             and so on back in the history. Highter depth
357                             generates wider suggestions, it might help to
358                             reduce looping over same artists.
359                             </para>
360                     </listitem>
361                 </varlistentry>
362                 <varlistentry> <!-- lastfm.single_album -->
363                     <term><option>single_album=</option><replaceable>false</replaceable></term>
364                     <listitem>
365                         <para>Prevent from queueing a track from the same album
366                             (it often happens with OST).<sbr />
367                             Only relevant in "track" queue mode.</para>
368                     </listitem>
369                 </varlistentry>
370                 <varlistentry> <!-- lastfm.track_to_add -->
371                     <term><option>track_to_add=</option><replaceable>1</replaceable></term>
372                     <listitem>
373                         <para>How many track(s) to add. Only relevant in
374                             <option>top</option> and <option>track</option>
375                             queue modes. This is actually an upper limit,
376                             min(<option>max_art</option>,
377                             <option>track_to_add</option>) will be used.</para>
378                     </listitem>
379                 </varlistentry>
380                 <varlistentry> <!-- lastfm.album_to_add -->
381                     <term><option>album_to_add=</option><replaceable>1</replaceable></term>
382                     <listitem>
383                         <para>How many album(s) to add. Only relevant in
384                             <option>album</option> queue modes.</para>
385                     </listitem>
386                 </varlistentry>
387                 <varlistentry> <!-- lastfm.track_to_add_from_album -->
388                     <term><option>track_to_add_from_album=</option><replaceable>0</replaceable></term>
389                     <listitem>
390                         <para>How many track(s) to add from each selected albums. Only relevant in
391                           <option>album</option> queue modes. When set to 0 or lower the whole album is queued.
392                           </para>
393                     </listitem>
394                 </varlistentry>
395                 <varlistentry> <!-- lastfm.cache -->
396                     <term><option>cache=</option><replaceable>True</replaceable></term>
397                     <listitem>
398                         <para>Whether or not to use on-disk persistent http
399                             cache.<sbr />When set to "true", sima will use a
400                             persistent cache for its http client. The cache is
401                             written along with the dbfile in:<sbr />
402                             <filename>$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE</filename>.<sbr/>
403                             If set to "false", caching is still done but in memory.
404                         </para>
405                     </listitem>
406                 </varlistentry>
407                 <varlistentry> <!-- lastfm.priority -->
408                     <term><option>priority=</option><replaceable>100</replaceable></term>
409                     <listitem>
410                         <para>
411                             Plugin priority
412                         </para>
413                     </listitem>
414                 </varlistentry>
415             </variablelist>
416         </refsect2>
417     </refsect1>
418     <refsect1 id="queue_mode">
419         <title>QUEUE MODES</title>
420         <para>&dhpackage; offers different queue modes. All of them pick up
421             tracks from artists similar to the last track in the queue.</para>
422         <para>&dhpackage; tries preferably to chose among unplayed artists or
423             at least not recently played artist. Concerning track and album
424             queue modes titles are chosen purely at random among unplayed
425             tracks.</para>
426         <variablelist>
427             <varlistentry>
428                 <term><option>track</option></term>
429                 <listitem>
430                     <para>Queue a similar track chosen at random from a similar artist.</para>
431                 </listitem>
432             </varlistentry>
433             <varlistentry>
434                 <term><option>top</option></term>
435                 <listitem>
436                     <para>Queue a track from a similar artist, chosen among
437                         "top tracks" according to last.fm data mining.</para>
438                 </listitem>
439             </varlistentry>
440             <varlistentry>
441                 <term><option>album</option></term>
442                 <listitem>
443                     <para>Queue a whole album chosen at random from a similar artist.</para>
444                     <para><emphasis>Nota Bene:</emphasis><sbr /> Due to the
445                         track point of view of database build upon tracks tags
446                         an album lookup for a specific artist will return
447                         albums as soon as this artist appears in a single track
448                         of the album.<sbr />
449                         For instance looking for album from "The Velvet
450                         Underground" will fetch "Last Days" and "Juno" OSTs
451                         because the band appears on the soundtrack of these two
452                         movies.<sbr />
453                         A solution is for you to set AlbumArtists tag to
454                         something different than the actual artist of the
455                         track. For compilations, OSTs etc. a strong convention
456                         is to use "Various Artists" for this tag.</para>
457                     <para>&dhpackage; is currently looking for AlbumArtists tags
458                         and avoid album where this tag is set with "Various
459                         Artists". If a single track within an album is found
460                         with AlbumArtists:"Various Artists" the complete album
461                         is skipped and won't be queued.</para>
462                 </listitem>
463             </varlistentry>
464         </variablelist>
465     </refsect1>
466   <xi:include href="files.xml" />
467   <xi:include href="feedback.xml" />
468   <xi:include href="seealso.xml" />
469 </refentry>