data/man/mpd_sima.cfg.5

   1 '\" t
   2 .\"     Title: mpd_sima.cfg
   3 .\"    Author: Jack Kaliko <kaliko@azylum.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 06/12/2014
   6 .\"    Manual: mpd-sima 0.12.0 User Manual
   7 .\"    Source: mpd-sima
   8 .\"  Language: English
   9 .\"
  10 .TH "MPD_SIMA\&.CFG" "5" "06/12/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 mpd_sima.cfg \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&. This manual document the configuration file for mpd\-sima\&.
  32 .SH "DESCRIPTION"
  33 .PP
  34 This manual page documents briefly
  35 \fBmpd\-sima\fR
  36 configuration options available in user configuration file (see
  37 the section called \(lqFILES\(rq)\&.
  38 .SH "EXAMPLES"
  39 .SS "Album queue mode\&."
  40 .PP
  41 Here is an example of album queue configuration\&.
  42 .sp
  43 .if n \{\
  44 .RS 4
  45 .\}
  46 .nf
  47 [MPD]
  48 host=example\&.org
  49 port=8000
  50
  51 [sima]
  52 history_duration=48  # 2 days
  53 queue_length=5
  54
  55 [lastfm]
  56 queue_mode = album
  57 album_to_add=2
  58
  59 [crop]
  60 # keep 30 played tracks in playlist
  61 consume = 30
  62
  63
  64 .fi
  65 .if n \{\
  66 .RE
  67 .\}
  68 .SH "CONFIGURATION FILE"
  69 .PP
  70 The configuration file consists of sections, led by a
  71 \fB[section]\fR
  72 header and followed by
  73 \fBname:\ \&value\fR
  74 entries, with continuations in the style of RFC 822 (see section 3\&.1\&.1, \(lqLONG HEADER FIELDS\(rq);
  75 \fBname=value\fR
  76 is also accepted\&. Lines beginning with
  77 \fI\*(Aq#\*(Aq\fR
  78 or
  79 \fI\*(Aq;\*(Aq\fR
  80 are ignored and may be used to provide comments (\fINota Bene:\fR
  81 inline comment are possible using
  82 \fI\*(Aq#\*(Aq\fR)\&.
  83 .PP
  84 The default values are used in the options lists below\&.
  85 .SS "MPD section"
  86 .PP
  87 This section is meant to configure MPD access, MPD host address / port and password if necessary\&.
  88 .PP
  89 \fB[MPD]\fR
  90 .RS 4
  91 .RE
  92 .PP
  93 \fBhost=\fR\fIlocalhost\fR
  94 .RS 4
  95 Set MPD host\&. Use IP or FQDN\&.
  96 .RE
  97 .PP
  98 \fBport=\fR\fI6600\fR
  99 .RS 4
 100 Set host port to access MPD to\&.
 101 .RE
 102 .PP
 103 \fBpassword=\fR\fIs3cr3t\fR
 104 .RS 4
 105 Set MPD password to use\&. Do not use this option if you don\*(Aqt have enabled password protected access on your MPD server\&.
 106 .RE
 107 .SS "log section"
 108 .PP
 109 Configure logging\&.
 110 .PP
 111 \fB[log]\fR
 112 .RS 4
 113 .RE
 114 .PP
 115 \fBlogfile=\fR
 116 .RS 4
 117 File to log to, usually in d\(aemon mode\&.
 118 .br
 119 Defaut (empty or unset) is to log to stdin/stdout\&.
 120 .RE
 121 .PP
 122 \fBverbosity=\fR\fIinfo\fR
 123 .RS 4
 124 Logging verbosity among
 125 \fIdebug\fR,
 126 \fIinfo\fR,
 127 \fIwarning\fR,
 128 \fIerror\fR\&.
 129 .RE
 130 .SS "sima section"
 131 .PP
 132 Core mpd_sima\&.cfg configuration\&.
 133 .PP
 134 \fB[sima]\fR
 135 .RS 4
 136 .RE
 137 .PP
 138 \fBhistory_duration=\fR\fI8\fR
 139 .RS 4
 140 How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
 141 .RE
 142 .PP
 143 \fBqueue_length=\fR\fI1\fR
 144 .RS 4
 145 This value triggers queue process if the queue length is less than specified queue_length\&.
 146 .RE
 147 .PP
 148 \fBuser_db=\fR\fIfalse\fR
 149 .RS 4
 150 Temporarily removed feature
 151 .RE
 152 .PP
 153 mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&.
 154 .br
 155
 156 Plugins list is a comma separated string list\&.
 157 .br
 158
 159 Optional plugin\*(Aqs configuration lays in its own section\&.
 160 .br
 161 For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&.
 162 .br
 163 internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&.
 164 .PP
 165 \fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR
 166 .RS 4
 167 \fBCrop\fR
 168 and
 169 \fBRandomFallback\fR
 170 are utilities plugins while
 171 \fBLastfm\fR
 172 is the actual queue plugin\&.
 173 .br
 174
 175 Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace
 176 \fBLastFm\fR
 177 with
 178 \fBEchoNest\fR
 179 to try\&.
 180 .RE
 181 .PP
 182 \fBcontrib=\fR
 183 .RS 4
 184 .RE
 185 .SS "Crop section"
 186 .PP
 187 crop plugin\*(Aqs configuration:
 188 .PP
 189 \fB[crop]\fR
 190 .RS 4
 191 .RE
 192 .PP
 193 \fBconsume=\fR\fI0\fR
 194 .RS 4
 195 How many played tracks to keep in the queue\&. Allow to maintain a fixed length queue\&. Set to 0 to keep all played tracks\&.
 196 .RE
 197 .SS "RandomFallback section"
 198 .PP
 199 RandomFallback plugin\*(Aqs configuration:
 200 .PP
 201 \fB[randomfallback]\fR
 202 .RS 4
 203 .RE
 204 .PP
 205 \fBflavour=\fR\fIsensible\fR
 206 .RS 4
 207 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available:
 208 \fIpure\fR,
 209 \fIsensible\fR,
 210 \fIgenre\fR\&.
 211 .sp
 212 .RS 4
 213 .ie n \{\
 214 \h'-04'\(bu\h'+03'\c
 215 .\}
 216 .el \{\
 217 .sp -1
 218 .IP \(bu 2.3
 219 .\}
 220 \fIpure\fR, pure random choice, even among recently played track\&.
 221 .RE
 222 .sp
 223 .RS 4
 224 .ie n \{\
 225 \h'-04'\(bu\h'+03'\c
 226 .\}
 227 .el \{\
 228 .sp -1
 229 .IP \(bu 2.3
 230 .\}
 231 \fIsensible\fR, use play history to filter chosen tracks\&.
 232 .RE
 233 .sp
 234 .RS 4
 235 .ie n \{\
 236 \h'-04'\(bu\h'+03'\c
 237 .\}
 238 .el \{\
 239 .sp -1
 240 .IP \(bu 2.3
 241 .\}
 242 \fIgenre\fR, Not implemented yet\&.
 243 .RE
 244 .sp
 245 .RE
 246 .SS "LastFm section"
 247 .PP
 248 LastFM plugin\*(Aqs configuration\&.
 249 .PP
 250 \fB[lastfm]\fR
 251 .RS 4
 252 .RE
 253 .PP
 254 \fBqueue_mode=\fR\fItrack\fR
 255 .RS 4
 256 Queue mode to use among
 257 \fItrack\fR,
 258 \fItop\fR
 259 and
 260 \fIalbum\fR
 261 (see
 262 the section called \(lqQUEUE MODES\(rq
 263 for info about queue modes)\&.
 264 .RE
 265 .PP
 266 \fBmax_art=\fR\fI10\fR
 267 .RS 4
 268 Number of similar artist to retrieve from local media library\&.
 269 .br
 270 When set to something superior to zero, it tries to get as much similar artists from media library\&.
 271 .RE
 272 .PP
 273 \fBdepth=\fR\fI1\fR
 274 .RS 4
 275 How many artists to base on similar artists search\&.
 276 .br
 277
 278 The first is the last played artist and so on back in the history\&. Highter depth allows to get wider suggestions, it might help to reduce looping over same artists\&.
 279 .RE
 280 .PP
 281 \fBsingle_album=\fR\fIfalse\fR
 282 .RS 4
 283 Prevent from queueing a track from the same album (it often happens with OST)\&.
 284 .br
 285
 286 Only relevant in "track" queue mode\&.
 287 .RE
 288 .PP
 289 \fBtrack_to_add=\fR\fI1\fR
 290 .RS 4
 291 How many track(s) to add\&. Only relevant in
 292 \fBtop\fR
 293 and
 294 \fBtrack\fR
 295 queue modes\&.
 296 .RE
 297 .PP
 298 \fBalbum_to_add=\fR\fI1\fR
 299 .RS 4
 300 How many album(s) to add\&. Only relevant in
 301 \fBalbum\fR
 302 queue modes\&.
 303 .RE
 304 .PP
 305 \fBcache=\fR\fITrue\fR
 306 .RS 4
 307 Whether or not to use on\-disk persistent http cache\&.
 308 .br
 309 When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in:
 310 .br
 311 $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
 312 .br
 313
 314 If set to "false", caching is still done but in memory\&.
 315 .RE
 316 .SH "QUEUE MODES"
 317 .PP
 318 mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
 319 .PP
 320 mpd\-sima 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\&.
 321 .PP
 322 \fBtrack\fR
 323 .RS 4
 324 Queue a similar track chosen at random from a similar artist\&.
 325 .RE
 326 .PP
 327 \fBtop\fR
 328 .RS 4
 329 Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&.
 330 .RE
 331 .PP
 332 \fBalbum\fR
 333 .RS 4
 334 Queue a whole album chosen at random from a similar artist\&.
 335 .sp
 336 \fINota Bene:\fR
 337 .br
 338
 339 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\&.
 340 .br
 341
 342 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\&.
 343 .br
 344
 345 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\&.
 346 .sp
 347 mpd\-sima 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\*(Aqt be queued\&.
 348 .br
 349
 350 It is planned to allow users to set the values of AlbumArtists tag triggering this behaviour\&. cf\&. feature request #2085 on the tracker\&.
 351 .RE
 352 .SH "FILES"
 353 .PP
 354 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 355 .RS 4
 356 Configuration file\&.
 357 .RE
 358 .PP
 359 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 360 .RS 4
 361 SQLite DB file\&.
 362 .RE
 363 .PP
 364 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 365 .RS 4
 366 Persistent http cache\&.
 367 .RE
 368 .PP
 369 Usually
 370 \fBXDG_DATA_HOME\fR
 371 is set to
 372 ${HOME}/\&.local/share
 373 and
 374 \fBXDG_CONFIG_HOME\fR
 375 to
 376 ${HOME}/\&.config\&.
 377 .br
 378 You may override them using command line option
 379 \fB\-\-var_dir\fR
 380 (cf\&.
 381 \fBmpd_sima\fR(1))
 382 .SH "FEEDBACK/BUGS"
 383 .PP
 384 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
 385 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
 386 .PP
 387 XMPP
 388 users are welcome to join the dedicated chat room at
 389 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 390 .SH "SEE ALSO"
 391 .PP
 392 \fBmpc\fR(1),
 393 \fBmpd\fR(1)
 394 .PP
 395 /usr/share/doc/mpd\-sima/
 396 .SH "AUTHOR"
 397 .PP
 398 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
 399 .RS 4
 400 Wrote this man page and is currently leading MPD_sima project\&.
 401 .RE
 402 .SH "COPYRIGHT"
 403 .br
 404 Copyright \(co 2009-2014 Jack Kaliko
 405 .br
 406 .PP
 407 This manual page was written for the Debian system (and may be used by others)\&.
 408 .PP
 409 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&.
 410 .PP
 411 On Debian systems, the complete text of the GNU General Public License can be found in
 412 /usr/share/common\-licenses/GPL\&.
 413 .sp