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/16/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/16/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 "Process daemonization"
 131 .PP
 132 Configure process daemon\&.
 133 .PP
 134 \fB[daemon]\fR
 135 .RS 4
 136 .RE
 137 .PP
 138 \fBdaemon=false\fR
 139 .RS 4
 140 whether to daemonize process or not\&.
 141 .RE
 142 .PP
 143 \fBpidfile=\fR
 144 .RS 4
 145 Where to store process ID\&.
 146 .RE
 147 .SS "sima section"
 148 .PP
 149 Core mpd_sima\&.cfg configuration\&.
 150 .PP
 151 \fB[sima]\fR
 152 .RS 4
 153 .RE
 154 .PP
 155 \fBhistory_duration=\fR\fI8\fR
 156 .RS 4
 157 How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
 158 .RE
 159 .PP
 160 \fBqueue_length=\fR\fI1\fR
 161 .RS 4
 162 This value triggers queue process if the queue length is less than specified queue_length\&.
 163 .RE
 164 .PP
 165 \fBuser_db=\fR\fIfalse\fR
 166 .RS 4
 167 Temporarily removed feature
 168 .RE
 169 .PP
 170 mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&.
 171 .br
 172
 173 Plugins list is a comma separated string list\&.
 174 .br
 175
 176 Optional plugin\*(Aqs configuration lays in its own section\&.
 177 .br
 178 For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&.
 179 .br
 180 internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&.
 181 .PP
 182 \fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR
 183 .RS 4
 184 \fBCrop\fR
 185 and
 186 \fBRandomFallback\fR
 187 are utilities plugins while
 188 \fBLastfm\fR
 189 is the actual queue plugin\&.
 190 .br
 191
 192 Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace
 193 \fBLastFm\fR
 194 with
 195 \fBEchoNest\fR
 196 to try\&.
 197 .RE
 198 .PP
 199 \fBcontrib=\fR
 200 .RS 4
 201 .RE
 202 .SS "Crop section"
 203 .PP
 204 crop plugin\*(Aqs configuration:
 205 .PP
 206 \fB[crop]\fR
 207 .RS 4
 208 .RE
 209 .PP
 210 \fBconsume=\fR\fI0\fR
 211 .RS 4
 212 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\&.
 213 .RE
 214 .SS "RandomFallback section"
 215 .PP
 216 RandomFallback plugin\*(Aqs configuration:
 217 .PP
 218 \fB[randomfallback]\fR
 219 .RS 4
 220 .RE
 221 .PP
 222 \fBflavour=\fR\fIsensible\fR
 223 .RS 4
 224 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available:
 225 \fIpure\fR,
 226 \fIsensible\fR,
 227 \fIgenre\fR\&.
 228 .sp
 229 .RS 4
 230 .ie n \{\
 231 \h'-04'\(bu\h'+03'\c
 232 .\}
 233 .el \{\
 234 .sp -1
 235 .IP \(bu 2.3
 236 .\}
 237 \fIpure\fR, pure random choice, even among recently played track\&.
 238 .RE
 239 .sp
 240 .RS 4
 241 .ie n \{\
 242 \h'-04'\(bu\h'+03'\c
 243 .\}
 244 .el \{\
 245 .sp -1
 246 .IP \(bu 2.3
 247 .\}
 248 \fIsensible\fR, use play history to filter chosen tracks\&.
 249 .RE
 250 .sp
 251 .RS 4
 252 .ie n \{\
 253 \h'-04'\(bu\h'+03'\c
 254 .\}
 255 .el \{\
 256 .sp -1
 257 .IP \(bu 2.3
 258 .\}
 259 \fIgenre\fR, Not implemented yet\&.
 260 .RE
 261 .sp
 262 .RE
 263 .SS "LastFm section"
 264 .PP
 265 LastFM plugin\*(Aqs configuration\&.
 266 .PP
 267 \fB[lastfm]\fR
 268 .RS 4
 269 .RE
 270 .PP
 271 \fBqueue_mode=\fR\fItrack\fR
 272 .RS 4
 273 Queue mode to use among
 274 \fItrack\fR,
 275 \fItop\fR
 276 and
 277 \fIalbum\fR
 278 (see
 279 the section called \(lqQUEUE MODES\(rq
 280 for info about queue modes)\&.
 281 .RE
 282 .PP
 283 \fBmax_art=\fR\fI10\fR
 284 .RS 4
 285 Number of similar artist to retrieve from local media library\&.
 286 .br
 287 When set to something superior to zero, it tries to get as much similar artists from media library\&.
 288 .RE
 289 .PP
 290 \fBdepth=\fR\fI1\fR
 291 .RS 4
 292 How many artists to base on similar artists search\&.
 293 .br
 294
 295 The first is the last played artist and so on back in the history\&. Highter depth generates wider suggestions, it might help to reduce looping over same artists\&.
 296 .RE
 297 .PP
 298 \fBsingle_album=\fR\fIfalse\fR
 299 .RS 4
 300 Prevent from queueing a track from the same album (it often happens with OST)\&.
 301 .br
 302
 303 Only relevant in "track" queue mode\&.
 304 .RE
 305 .PP
 306 \fBtrack_to_add=\fR\fI1\fR
 307 .RS 4
 308 How many track(s) to add\&. Only relevant in
 309 \fBtop\fR
 310 and
 311 \fBtrack\fR
 312 queue modes\&.
 313 .RE
 314 .PP
 315 \fBalbum_to_add=\fR\fI1\fR
 316 .RS 4
 317 How many album(s) to add\&. Only relevant in
 318 \fBalbum\fR
 319 queue modes\&.
 320 .RE
 321 .PP
 322 \fBcache=\fR\fITrue\fR
 323 .RS 4
 324 Whether or not to use on\-disk persistent http cache\&.
 325 .br
 326 When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in:
 327 .br
 328 $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
 329 .br
 330
 331 If set to "false", caching is still done but in memory\&.
 332 .RE
 333 .SH "QUEUE MODES"
 334 .PP
 335 mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
 336 .PP
 337 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\&.
 338 .PP
 339 \fBtrack\fR
 340 .RS 4
 341 Queue a similar track chosen at random from a similar artist\&.
 342 .RE
 343 .PP
 344 \fBtop\fR
 345 .RS 4
 346 Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&.
 347 .RE
 348 .PP
 349 \fBalbum\fR
 350 .RS 4
 351 Queue a whole album chosen at random from a similar artist\&.
 352 .sp
 353 \fINota Bene:\fR
 354 .br
 355
 356 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\&.
 357 .br
 358
 359 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\&.
 360 .br
 361
 362 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\&.
 363 .sp
 364 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\&.
 365 .br
 366
 367 It is planned to allow users to set the values of AlbumArtists tag triggering this behaviour\&. cf\&. feature request #2085 on the tracker\&.
 368 .RE
 369 .SH "FILES"
 370 .PP
 371 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 372 .RS 4
 373 Configuration file\&.
 374 .RE
 375 .PP
 376 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 377 .RS 4
 378 SQLite DB file\&.
 379 .RE
 380 .PP
 381 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 382 .RS 4
 383 Persistent http cache\&.
 384 .RE
 385 .PP
 386 Usually
 387 \fBXDG_DATA_HOME\fR
 388 is set to
 389 ${HOME}/\&.local/share
 390 and
 391 \fBXDG_CONFIG_HOME\fR
 392 to
 393 ${HOME}/\&.config\&.
 394 .br
 395 You may override them using command line option
 396 \fB\-\-var_dir\fR
 397 (cf\&.
 398 \fBmpd_sima\fR(1))
 399 .SH "FEEDBACK/BUGS"
 400 .PP
 401 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
 402 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
 403 .PP
 404 XMPP
 405 users are welcome to join the dedicated chat room at
 406 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 407 .SH "SEE ALSO"
 408 .PP
 409 \fBmpc\fR(1),
 410 \fBmpd\fR(1)
 411 .PP
 412 /usr/share/doc/mpd\-sima/
 413 .SH "AUTHOR"
 414 .PP
 415 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
 416 .RS 4
 417 Wrote this man page and is currently leading MPD_sima project\&.
 418 .RE
 419 .SH "COPYRIGHT"
 420 .br
 421 Copyright \(co 2009-2014 Jack Kaliko
 422 .br
 423 .PP
 424 This manual page was written for the Debian system (and may be used by others)\&.
 425 .PP
 426 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\&.
 427 .PP
 428 On Debian systems, the complete text of the GNU General Public License can be found in
 429 /usr/share/common\-licenses/GPL\&.
 430 .sp