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="tags">
  79             <title>File tags queue mode (offline mode).</title>
  80             <para>Here is an example of autoqueue using file tags only.</para>
  81             <programlisting><xi:include href="tags.cfg" parse="text" />
  82             </programlisting>
  83         </refsect2>
  84         <refsect2 id="album">
  85             <title>Album queue mode using last.fm recommendations (online mode).</title>
  86             <para>Here is an example of album queue configuration using online recommendations system.</para>
  87             <programlisting><xi:include href="album.cfg" parse="text" />
  88             </programlisting>
  89         </refsect2>
  90     </refsect1>
  91
  92     <refsect1 id="options">
  93         <title>Configuration file</title>
  94         <para>The configuration file consists of sections, led by a
  95             <command>[section]</command> header and followed by <option>name: value</option>
  96             entries, with continuations in the style of RFC 822 (see section
  97             3.1.1, “LONG HEADER FIELDS”); <option>name=value</option> is also accepted. Lines
  98             beginning with <parameter>'#'</parameter> or <parameter>';'</parameter>
  99             are ignored and may be used to provide comments (<emphasis>Nota
 100                 Bene:</emphasis> inline comment are possible using <parameter>'#'</parameter>).</para>
 101         <title>OPTIONS</title>
 102         <para>The default values are used in the options lists below.</para>
 103         <refsect2 id="MPD">
 104             <title>MPD section</title>
 105             <para>This section is meant to configure MPD access, MPD host
 106                 address / port and password if necessary.</para>
 107             <variablelist>
 108                 <!-- Use the variablelist.term.separator and the
 109                 variablelist.term.break.after parameters to
 110                 control the term elements. -->
 111                 <varlistentry> <!-- MPD -->
 112                     <term><option>[MPD]</option></term>
 113                     <listitem></listitem>
 114                 </varlistentry>
 115                 <varlistentry> <!-- MPD.host -->
 116                     <term><option>host=</option><replaceable>localhost</replaceable></term>
 117                     <listitem>
 118                         <para>Set MPD host. Use IP or FQDN.</para>
 119                     </listitem>
 120                 </varlistentry>
 121                 <varlistentry> <!-- MPD.port -->
 122                     <term><option>port=</option><replaceable>6600</replaceable></term>
 123                     <listitem>
 124                         <para>Set host port to access MPD to.</para>
 125                     </listitem>
 126                 </varlistentry>
 127                 <varlistentry> <!-- MPD.password -->
 128                     <term><option>password=</option><replaceable>s3cr3t</replaceable></term>
 129                     <listitem>
 130                         <para>Set MPD password to use. Do not use this option
 131                             if you don't have enabled password protected access
 132                             on your MPD server.</para>
 133                     </listitem>
 134                 </varlistentry>
 135             </variablelist>
 136         </refsect2>
 137         <refsect2 id="log">
 138             <title>log section</title>
 139             <para>Configure logging.</para>
 140             <variablelist>
 141                 <varlistentry> <!-- LOG -->
 142                     <term><option>[log]</option></term>
 143                     <listitem><para></para></listitem>
 144                 </varlistentry>
 145                 <varlistentry> <!-- log.logfile -->
 146                     <term><option>logfile=</option></term>
 147                     <listitem>
 148                         <para>File to log to, usually in dæmon mode.<sbr />Default
 149                             (empty or unset) is to log to stdin/stdout.</para>
 150                     </listitem>
 151                 </varlistentry>
 152                 <varlistentry> <!-- log.verbosity -->
 153                     <term><option>verbosity=</option><replaceable>info</replaceable></term>
 154                     <listitem>
 155                         <para>Logging verbosity among
 156                             <replaceable>debug</replaceable>,
 157                             <replaceable>info</replaceable>,
 158                             <replaceable>warning</replaceable>,
 159                             <replaceable>error</replaceable>.</para>
 160                     </listitem>
 161                 </varlistentry>
 162             </variablelist>
 163         </refsect2>
 164         <refsect2 id="daemon">
 165             <title>Process daemonization</title>
 166             <para>Configure process daemon.</para>
 167             <variablelist>
 168                 <varlistentry> <!-- DAEMON -->
 169                     <term><option>[daemon]</option></term>
 170                     <listitem><para></para></listitem>
 171                 </varlistentry>
 172                 <varlistentry> <!-- daemon.daemon -->
 173                     <term><option>daemon=false</option></term>
 174                     <listitem>
 175                         <para>whether to daemonize process or not.</para>
 176                     </listitem>
 177                 </varlistentry>
 178                 <varlistentry> <!-- daemon.pidfile -->
 179                     <term><option>pidfile=</option></term>
 180                     <listitem>
 181                         <para>Where to store process ID.</para>
 182                     </listitem>
 183                 </varlistentry>
 184             </variablelist>
 185         </refsect2>
 186         <refsect2 id="sima">
 187             <title>sima section</title>
 188             <para>Core &dhutils; configuration.</para>
 189             <variablelist>
 190                 <varlistentry> <!-- SIMA -->
 191                     <term><option>[sima]</option></term>
 192                     <listitem><para></para></listitem>
 193                 </varlistentry>
 194                 <variablelist>
 195                     <varlistentry> <!-- sima.contrib -->
 196                         <term><option>contrib=</option><replaceable></replaceable></term>
 197                         <listitem>
 198                             <para></para>
 199                         </listitem>
 200                     </varlistentry>
 201                     <varlistentry> <!-- sima.internal -->
 202                         <term><option>internal=</option><replaceable>Lastfm, Random, Crop</replaceable></term>
 203                         <listitem>
 204                             <para>&dhpackage;'s plugin management for internal source plugin
 205                                 and contrib (ie. external plugins).<sbr /> Plugins list is a
 206                                 comma separated string list.<sbr /> Optional plugin's
 207                                 configuration lays in its own section.<sbr />For instance a
 208                                 "AwesomePlugin" declared here gets its configuration from the
 209                                 corresponding section "[awesomeplugin]".
 210                             </para>
 211                             <para>The default list of plugins to load at startup: <option>Lastfm</option>,<option>Random</option>,<option>Crop</option>.<sbr />
 212                                 <option>Crop</option> is an utility plugin, it does not queue any tracks (cf. below).<sbr />
 213                                 <option>Random</option> will queue a track at random if other plugins did not return any tracks.<sbr />
 214                             </para>
 215                             <para>You can add, combine here as many plugins you want.<sbr />
 216                                 The priority may be used to order them.
 217                             </para>
 218                         </listitem>
 219                     </varlistentry>
 220                     <varlistentry> <!-- sima.history_duration -->
 221                         <term><option>history_duration=</option><replaceable>8</replaceable></term>
 222                         <listitem>
 223                             <para>How far to look back in history to avoid to play
 224                                 twice the same track/title (duration in
 225                                 hours).<sbr />
 226                                 The <option>history_duration</option> is also used to give priority to not recently played artists.
 227                             </para>
 228                         </listitem>
 229                     </varlistentry>
 230                     <varlistentry> <!-- sima.queue_length -->
 231                         <term><option>queue_length=</option><replaceable>2</replaceable></term>
 232                         <listitem>
 233                             <para>Threshold value triggering queue process.</para>
 234                         </listitem>
 235                     </varlistentry>
 236                     <varlistentry> <!-- sima.musicbrainzid -->
 237                         <term><option>musicbrainzid=</option><replaceable>true</replaceable></term>
 238                         <listitem>
 239                             <para>Use MusicBrainzIdentifier to search music (mainly
 240                                 for artists).
 241                                 Default is True, switch to False if you don't have
 242                                 MusicBrainzIdentifier set for at least 80% of you
 243                                 music library.<sbr /> Consider using these metadata as it
 244                                 enhances a lot artist/album/tracks identification.
 245                                 Use Picard to tag your file: <ulink url="https://picard.musicbrainz.org/"/>.
 246                             </para>
 247                         </listitem>
 248                     </varlistentry>
 249                     <varlistentry> <!-- sima.repeat_disable_queue -->
 250                         <term><option>repeat_disable_queue=</option><replaceable>true</replaceable></term>
 251                         <listitem>
 252                             <para>Prevent disabling queuing in repeat play mode.
 253                             </para>
 254                         </listitem>
 255                     </varlistentry>
 256                     <varlistentry> <!-- sima.single_disable_queue -->
 257                         <term><option>single_disable_queue=</option><replaceable>true</replaceable></term>
 258                         <listitem>
 259                             <para>Prevent disabling queuing in single play mode.
 260                             </para>
 261                         </listitem>
 262                     </varlistentry>
 263                 </variablelist>
 264             </variablelist>
 265         </refsect2>
 266         <refsect2 id="crop">
 267             <title>Crop section</title>
 268             <para>crop plugin's configuration:</para>
 269                 <varlistentry> <!-- crop -->
 270                     <term><option>[crop]</option></term>
 271                 </varlistentry>
 272                 <varlistentry> <!-- crop.consume -->
 273                     <term><option>consume=</option><replaceable>10</replaceable></term>
 274                     <listitem>
 275                         <para>How many played tracks to keep in the queue.
 276                             Allows you to maintain a fixed length queue.
 277                             Set to some negative integer to keep all played tracks.
 278                         </para>
 279                     </listitem>
 280                 </varlistentry>
 281                 <varlistentry> <!-- crop.priority -->
 282                     <term><option>priority=</option><replaceable>10</replaceable></term>
 283                     <listitem>
 284                         <para>
 285                             Plugin priority
 286                         </para>
 287                     </listitem>
 288                 </varlistentry>
 289         </refsect2>
 290         <refsect2 id="random">
 291             <title>Random section</title>
 292             <para>Random plugin's configuration:</para>
 293                 <varlistentry> <!-- random -->
 294                     <term><option>[random]</option></term>
 295                 </varlistentry>
 296                 <varlistentry> <!-- random.track_to_add -->
 297                     <term><option>track_to_add=</option><replaceable>1</replaceable></term>
 298                     <listitem>
 299                         <para>How many track(s) to add.</para>
 300                     </listitem>
 301                 </varlistentry>
 302                 <varlistentry> <!-- random.flavour -->
 303                     <term><option>flavour=</option><replaceable>sensible</replaceable></term>
 304                     <listitem>
 305                         <para>When no similar tracks are found, falling back to
 306                             random queuing. Different mode, aka random flavour,
 307                             are available:
 308                             <replaceable>pure</replaceable>,
 309                             <replaceable>sensible</replaceable>,
 310                             <replaceable>genre</replaceable>.
 311                             <itemizedlist mark='bullet'>
 312                                 <listitem>
 313                                     <para><replaceable>pure</replaceable>, pure random choice, even among recently played track.
 314                                     </para>
 315                                 </listitem>
 316                                 <listitem >
 317                                     <para><replaceable>sensible</replaceable>, use play history to filter chosen tracks.
 318                                     </para>
 319                                 </listitem>
 320                                 <listitem>
 321                                     <para><replaceable>genre</replaceable>, Not implemented yet.
 322                                     </para>
 323                                 </listitem>
 324                             </itemizedlist>
 325                         </para>
 326                     </listitem>
 327                 </varlistentry>
 328                 <varlistentry> <!-- random.priority -->
 329                     <term><option>priority=</option><replaceable>50</replaceable></term>
 330                     <listitem>
 331                         <para>
 332                             Plugin priority
 333                         </para>
 334                     </listitem>
 335                 </varlistentry>
 336         </refsect2>
 337         <refsect2 id="lastfm">
 338             <title>LastFm section</title>
 339             <para>LastFM plugin's configuration.</para>
 340             <variablelist>
 341                 <varlistentry> <!-- lastfm -->
 342                     <term><option>[lastfm]</option></term>
 343                 </varlistentry>
 344                 <varlistentry> <!-- lastfm.queue_mode -->
 345                     <term><option>queue_mode=</option><replaceable>track</replaceable></term>
 346                     <listitem>
 347                         <para>Queue mode to use among
 348                             <replaceable>track</replaceable>,
 349                             <replaceable>top</replaceable> and
 350                             <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
 351                     </listitem>
 352                 </varlistentry>
 353                 <varlistentry> <!-- lastfm.max_art -->
 354                     <term><option>max_art=</option><replaceable>10</replaceable></term>
 355                     <listitem>
 356                         <para>Maximum number of similar artist to retrieve from local
 357                             media library.<sbr />When set to something superior
 358                             to zero, it tries to get as much similar artists
 359                             from media library.</para>
 360                     </listitem>
 361                 </varlistentry>
 362                 <varlistentry> <!-- lastfm.depth -->
 363                     <term><option>depth=</option><replaceable>1</replaceable></term>
 364                     <listitem>
 365                         <para>How many artists to base on similar artists
 366                             search.<sbr /> The first is the last played artist
 367                             and so on back in the history. Highter depth
 368                             generates wider suggestions, it might help to
 369                             reduce looping over same artists.
 370                             </para>
 371                     </listitem>
 372                 </varlistentry>
 373                 <varlistentry> <!-- lastfm.single_album -->
 374                     <term><option>single_album=</option><replaceable>false</replaceable></term>
 375                     <listitem>
 376                         <para>Prevent from queueing a track from the same album
 377                             (it often happens with OST).<sbr />
 378                             Only relevant in "track" queue mode.</para>
 379                     </listitem>
 380                 </varlistentry>
 381                 <varlistentry> <!-- lastfm.track_to_add -->
 382                     <term><option>track_to_add=</option><replaceable>1</replaceable></term>
 383                     <listitem>
 384                         <para>How many track(s) to add. Only relevant in
 385                             <option>top</option> and <option>track</option>
 386                             queue modes. This is actually an upper limit,
 387                             min(<option>max_art</option>,
 388                             <option>track_to_add</option>) will be used.</para>
 389                     </listitem>
 390                 </varlistentry>
 391                 <varlistentry> <!-- lastfm.album_to_add -->
 392                     <term><option>album_to_add=</option><replaceable>1</replaceable></term>
 393                     <listitem>
 394                         <para>How many album(s) to add. Only relevant in
 395                             <option>album</option> queue modes.</para>
 396                     </listitem>
 397                 </varlistentry>
 398                 <varlistentry> <!-- lastfm.track_to_add_from_album -->
 399                     <term><option>track_to_add_from_album=</option><replaceable>0</replaceable></term>
 400                     <listitem>
 401                         <para>How many track(s) to add from each selected albums. Only relevant in
 402                           <option>album</option> queue modes. When set to 0 or lower the whole album is queued.
 403                           </para>
 404                     </listitem>
 405                 </varlistentry>
 406                 <varlistentry> <!-- lastfm.cache -->
 407                     <term><option>cache=</option><replaceable>True</replaceable></term>
 408                     <listitem>
 409                         <para>Whether or not to use on-disk persistent http
 410                             cache.<sbr />When set to "true", sima will use a
 411                             persistent cache for its http client. The cache is
 412                             written along with the dbfile in:<sbr />
 413                             <filename>$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE</filename>.<sbr/>
 414                             If set to "false", caching is still done but in memory.
 415                         </para>
 416                     </listitem>
 417                 </varlistentry>
 418                 <varlistentry> <!-- lastfm.priority -->
 419                     <term><option>priority=</option><replaceable>100</replaceable></term>
 420                     <listitem>
 421                         <para>
 422                             Plugin priority
 423                         </para>
 424                     </listitem>
 425                 </varlistentry>
 426             </variablelist>
 427         </refsect2>
 428         <refsect2 id="tags">
 429             <title>Tags section</title>
 430             <para>Tags plugin's configuration. There is no default configuration for this plugin,
 431               it does not work out of the box.</para>
 432             <para>This plugin permits offline autoqueuing based on files tags only. Supported tags are
 433               <option>'comment'</option>, <option>'date'</option>, <option>'genre'</option>,
 434               <option>'label'</option> and <option>'originaldate'</option>.</para>
 435             <para>In addition to supported tags above you can use an MPD filter. Please refer to
 436               MPD protocol documentation for more.</para>
 437             <para>All tag entries in this section are ANDed as a single MPD filter to look for titles
 438               in the library. Moreover, for each tags, comma separated values are also ORed.<sbr />
 439               For instance setting "<option>genre=rock</option>" and
 440               "<option>date=1982,1983,1984,1985,1986,1987,1988,1989</option>"
 441               will end up looking for track tagged with genre <option>rock</option>
 442               and date within 1982 through 1989.<sbr />
 443               Using an MPD filter to replace <option>date</option> you can achieve
 444               the same with the following setting: "<option>genre=rock</option>" and
 445               "<option>filter=(date =~ '198[2-9]+')</option>" (provided your MPD server
 446               was compiled with libpcre).
 447             </para>
 448                 <varlistentry> <!-- tags -->
 449                    <term><option>[tags]</option></term>
 450                 </varlistentry>
 451                 <varlistentry> <!-- tags.queue_mode -->
 452                     <term><option>queue_mode=</option><replaceable>track</replaceable></term>
 453                     <listitem>
 454                         <para>Queue mode to use among
 455                             <replaceable>track</replaceable>,
 456                             <replaceable>album</replaceable> (see <xref linkend="queue_mode"/> for info about queue modes).</para>
 457                     </listitem>
 458                 </varlistentry>
 459                 <varlistentry> <!-- tags.filter -->
 460                     <term><option>filter=</option></term>
 461                     <listitem>
 462                         <para>You can use here any valid MPD filter as defined in MPD protocol documentation.</para>
 463                     </listitem>
 464                 </varlistentry>
 465                 <varlistentry> <!-- tags.comment -->
 466                     <term><option>comment=</option></term>
 467                 </varlistentry>
 468                 <varlistentry> <!-- tags.date -->
 469                     <term><option>date=</option></term>
 470                 </varlistentry>
 471                 <varlistentry> <!-- tags.genre -->
 472                     <term><option>genre=</option></term>
 473                 </varlistentry>
 474                 <varlistentry> <!-- tags.label -->
 475                     <term><option>label=</option></term>
 476                 </varlistentry>
 477                 <varlistentry> <!-- tags.originaldate -->
 478                     <term><option>originaldate=</option></term>
 479                 </varlistentry>
 480                 <varlistentry> <!-- tags.priority -->
 481                     <term><option>priority=</option><replaceable>80</replaceable></term>
 482                     <listitem>
 483                         <para>
 484                             Plugin priority
 485                         </para>
 486                     </listitem>
 487                 </varlistentry>
 488                 <varlistentry> <!-- tags.track_to_add -->
 489                     <term><option>track_to_add=</option><replaceable>1</replaceable></term>
 490                     <listitem>
 491                         <para>How many track(s) to add.</para>
 492                     </listitem>
 493                 </varlistentry>
 494                 <varlistentry> <!-- tags.album_to_add -->
 495                     <term><option>album_to_add=</option><replaceable>1</replaceable></term>
 496                     <listitem>
 497                         <para>How many album(s) to add. Only relevant in
 498                             <option>album</option> queue mode.</para>
 499                     </listitem>
 500                 </varlistentry>
 501         </refsect2>
 502     </refsect1>
 503     <refsect1 id="queue_mode">
 504         <title>QUEUE MODES</title>
 505         <para>Different queue modes are available with some plugins (check for
 506         <option>queue_mode</option> presence in plugin config).
 507         </para>
 508         <para>&dhpackage; tries preferably to chose among unplayed artists or
 509         at least not recently played artist.</para>
 510         <variablelist>
 511           <varlistentry>
 512             <term><option>track</option></term>
 513             <listitem>
 514               <para>Queue a similar track chosen at random from a similar artist.</para>
 515             </listitem>
 516           </varlistentry>
 517           <varlistentry>
 518             <term><option>top</option></term>
 519             <listitem>
 520               <para>Queue a track from a similar artist, chosen among
 521                 "top tracks" according to last.fm data mining.</para>
 522             </listitem>
 523           </varlistentry>
 524           <varlistentry>
 525             <term><option>album</option></term>
 526             <listitem>
 527               <para>Queue a whole album chosen at random from a similar artist.</para>
 528               <para><emphasis>Nota Bene:</emphasis><sbr /> Due to the
 529                 track point of view of database build upon tracks tags
 530                 an album lookup for a specific artist will return
 531                 albums as soon as this artist appears in a single track
 532                 of the album.<sbr />
 533                 For instance looking for album from "The Velvet
 534                 Underground" will fetch "Last Days" and "Juno" OSTs
 535                 because the band appears on the soundtrack of these two
 536                 movies.<sbr />
 537                 A solution is for you to set AlbumArtists tag to
 538                 something different than the actual artist of the
 539                 track. For compilations, OSTs etc. a strong convention
 540                 is to use "Various Artists" for this tag.</para>
 541               <para>&dhpackage; is currently looking for AlbumArtists tags
 542                 and avoid album where this tag is set with "Various
 543                 Artists". If a single track within an album is found
 544                 with AlbumArtists:"Various Artists" the complete album
 545                 is skipped and won't be queued.</para>
 546             </listitem>
 547           </varlistentry>
 548         </variablelist>
 549     </refsect1>
 550   <xi:include href="files.xml" />
 551   <xi:include href="feedback.xml" />
 552   <xi:include href="seealso.xml" />
 553 </refentry>
 554 <!-- vim: tabstop=4 softtabstop=4 shiftwidth=4 :
 555 -->