]> kaliko git repositories - mpd-sima.git/blobdiff - data/man/mpd_sima.cfg.5
Releasing 0.15.2
[mpd-sima.git] / data / man / mpd_sima.cfg.5
index d5e0c5793cb1d1f6a582aaf46724d05ca1345b0a..dde5bac953d175e59be3c0c42c5dcd98f222c5ed 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: mpd_sima.cfg
 .\"    Author: Jack Kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 09/20/2015
-.\"    Manual: mpd-sima 0.14.0 User Manual
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 11/14/2019
+.\"    Manual: mpd-sima 0.15.2 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD_SIMA\&.CFG" "5" "09/20/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "11/14/2019" "mpd-sima" "mpd-sima 0.15.2 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -116,7 +116,7 @@ Configure logging\&.
 .RS 4
 File to log to, usually in d\(aemon mode\&.
 .br
-Defaut (empty or unset) is to log to stdin/stdout\&.
+Default (empty or unset) is to log to stdin/stdout\&.
 .RE
 .PP
 \fBverbosity=\fR\fIinfo\fR
@@ -171,9 +171,11 @@ For instance a "AwesomePlugin" declared here gets its configuration from the cor
 The default list of plugins to load at startup:
 \fBLastfm\fR,\fBRandom\fR,\fBCrop\fR\&.
 .br
+
 \fBCrop\fR
 is an utility plugin, it does not queue any tracks (cf\&. below)\&.
 .br
+
 \fBRandom\fR
 will queue a track at random if other plugins did not return any tracks\&.
 .br
@@ -181,8 +183,6 @@ will queue a track at random if other plugins did not return any tracks\&.
 .sp
 You can add here as many plugins you want, currently shipping
 \fBLastfm\fR
-and
-\fBEchoNest\fR
 only\&.
 .br
 
@@ -212,6 +212,16 @@ Use MusicBrainzIdentifier to search music (mainly for artists)\&. Default is Tru
 Consider using these metadata as it enhances a lot artist/album/tracks identification\&. Use Picard to tag your file:
 \m[blue]\fB\%https://picard.musicbrainz.org/\fR\m[]\&.
 .RE
+.PP
+\fBrepeat_disable_queue=\fR\fItrue\fR
+.RS 4
+Prevent disabling queuing in repeat play mode\&.
+.RE
+.PP
+\fBsingle_disable_queue=\fR\fItrue\fR
+.RS 4
+Prevent disabling queuing in single play mode\&.
+.RE
 .SS "Crop section"
 .PP
 crop plugin\*(Aqs configuration:
@@ -305,7 +315,7 @@ for info about queue modes)\&.
 .PP
 \fBmax_art=\fR\fI10\fR
 .RS 4
-Number of similar artist to retrieve from local media library\&.
+Maximum number of similar artist to retrieve from local media library\&.
 .br
 When set to something superior to zero, it tries to get as much similar artists from media library\&.
 .RE
@@ -332,7 +342,8 @@ How many track(s) to add\&. Only relevant in
 \fBtop\fR
 and
 \fBtrack\fR
-queue modes\&.
+queue modes\&. This is actually an upper limit, min(\fBmax_art\fR,
+\fBtrack_to_add\fR) will be used\&.
 .RE
 .PP
 \fBalbum_to_add=\fR\fI1\fR
@@ -342,12 +353,20 @@ How many album(s) to add\&. Only relevant in
 queue modes\&.
 .RE
 .PP
+\fBtrack_to_add_from_album=\fR\fI0\fR
+.RS 4
+How many track(s) to add from each selected albums\&. Only relevant in
+\fBalbum\fR
+queue modes\&. When set to 0 or lower the whole album is queued\&.
+.RE
+.PP
 \fBcache=\fR\fITrue\fR
 .RS 4
 Whether or not to use on\-disk persistent http cache\&.
 .br
 When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in:
 .br
+
 $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
 .br
 
@@ -358,43 +377,6 @@ If set to "false", caching is still done but in memory\&.
 .RS 4
 Plugin priority
 .RE
-.SS "EchoNest section"
-.PP
-EchoNest plugin\*(Aqs configuration\&.
-.PP
-Options for EchoNest are exactly the same as LastFm (same default as well), except for cache plugin which is always needed to limit number of requests to the service\&.
-.PP
-\fB[echonest]\fR
-.RS 4
-.RE
-.PP
-\fBqueue_mode=\fR\fItrack\fR
-.RS 4
-.RE
-.PP
-\fBmax_art=\fR\fI10\fR
-.RS 4
-.RE
-.PP
-\fBdepth=\fR\fI1\fR
-.RS 4
-.RE
-.PP
-\fBsingle_album=\fR\fIfalse\fR
-.RS 4
-.RE
-.PP
-\fBtrack_to_add=\fR\fI1\fR
-.RS 4
-.RE
-.PP
-\fBalbum_to_add=\fR\fI1\fR
-.RS 4
-.RE
-.PP
-\fBpriority=\fR\fI100\fR
-.RS 4
-.RE
 .SH "QUEUE MODES"
 .PP
 mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
@@ -463,7 +445,7 @@ and
 .SH "FEEDBACK/BUGS"
 .PP
 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
-\m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
+\m[blue]\fB\%https://kaliko.me/contact/\fR\m[]\&.
 .PP
 XMPP
 users are welcome to join the dedicated chat room at
@@ -482,7 +464,7 @@ Wrote this man page and is currently leading MPD_sima project\&.
 .RE
 .SH "COPYRIGHT"
 .br
-Copyright \(co 2009-2015 Jack Kaliko
+Copyright \(co 2009-2019 Jack Kaliko
 .br
 .PP
 This manual page was written for the Debian system (and may be used by others)\&.