'\" t
.\" Title: mpd_sima.cfg
.\" Author: Jack Kaliko <kaliko@azylum.org>
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 06/10/2014
-.\" Manual: mpd-sima 0.12.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" "06/10/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "11/14/2019" "mpd-sima" "mpd-sima 0.15.2 User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-mpd_sima.cfg \- mpd\-sima will try to maintain some titles ahead in your play list following different policies\&. This manual document the configuration file for mpd\-sima\&.
+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\&.
.SH "DESCRIPTION"
.PP
This manual page documents briefly
queue_length=5
[lastfm]
-queue_mode = album
+queue_mode=album
album_to_add=2
[crop]
# keep 30 played tracks in playlist
-consume = 30
+consume=30
.fi
.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
\fIwarning\fR,
\fIerror\fR\&.
.RE
-.SS "sima section"
+.SS "Process daemonization"
.PP
-This section allows you to tweak core mpd_sima\&.cfg configuration\&.
+Configure process daemon\&.
.PP
-\fB[sima]\fR
+\fB[daemon]\fR
.RS 4
.RE
.PP
-\fBhistory_duration=\fR\fI8\fR
+\fBdaemon=false\fR
.RS 4
-How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
+whether to daemonize process or not\&.
.RE
.PP
-\fBqueue_length=\fR\fI1\fR
+\fBpidfile=\fR
.RS 4
-This value triggers queue process if the play list length is less than specified queue_length\&.
+Where to store process ID\&.
.RE
+.SS "sima section"
+.PP
+Core mpd_sima\&.cfg configuration\&.
.PP
-\fBuser_db=\fR\fIfalse\fR
+\fB[sima]\fR
.RS 4
-Temporarily removed feature
.RE
.PP
+\fBcontrib=\fR
+.RS 4
+.RE
+.PP
+\fBinternal=\fR\fILastfm, Random, Crop\fR
+.RS 4
mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&.
.br
Optional plugin\*(Aqs configuration lays in its own section\&.
.br
For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&.
+.sp
+The default list of plugins to load at startup:
+\fBLastfm\fR,\fBRandom\fR,\fBCrop\fR\&.
.br
-internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&.
-.PP
-\fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR
-.RS 4
+
\fBCrop\fR
-and
-\fBRandomFallback\fR
-are utilities plugins while
+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
+
+.sp
+You can add here as many plugins you want, currently shipping
\fBLastfm\fR
-is the actual queue plugin\&.
+only\&.
.br
-Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace
-\fBLastFm\fR
-with
-\fBEchoNest\fR
-to try\&.
+The priority may be used to order them\&.
.RE
.PP
-\fBcontrib=\fR
+\fBhistory_duration=\fR\fI8\fR
+.RS 4
+How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
+.br
+
+The
+\fBhistory_duration\fR
+is also used to give priority to not recently played artists\&.
+.RE
+.PP
+\fBqueue_length=\fR\fI2\fR
.RS 4
+Threshold value triggering queue process\&.
+.RE
+.PP
+\fBmusicbrainzid=\fR\fItrue\fR
+.RS 4
+Use MusicBrainzIdentifier to search music (mainly for artists)\&. Default is True, switch to False if you don\*(Aqt have MusicBrainzIdentifier set for at least 80% of you music library\&.
+.br
+
+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
.RS 4
.RE
.PP
-\fBconsume=\fR\fI0\fR
+\fBconsume=\fR\fI10\fR
.RS 4
-How many played tracks to keep in the play list\&. Allow to maintain a fixed length play list\&. Set to 0 to keep all played tracks\&.
+How many played tracks to keep in the queue\&. Allows you to maintain a fixed length queue\&. Set to some negative integer to keep all played tracks\&.
.RE
-.SS "RandomFallback section"
.PP
-RandomFallback plugin\*(Aqs configuration:
+\fBpriority=\fR\fI10\fR
+.RS 4
+Plugin priority
+.RE
+.SS "Random section"
+.PP
+Random plugin\*(Aqs configuration:
.PP
-\fB[randomfallback]\fR
+\fB[random]\fR
.RS 4
.RE
.PP
.RE
.sp
.RE
+.PP
+\fBpriority=\fR\fI50\fR
+.RS 4
+Plugin priority
+.RE
.SS "LastFm section"
.PP
-This section allows you to tweak LastFM plugin\*(Aqs configuration\&.
+LastFM plugin\*(Aqs configuration\&.
.PP
\fB[lastfm]\fR
.RS 4
.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
How many artists to base on similar artists search\&.
.br
-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\&.
+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\&.
.RE
.PP
\fBsingle_album=\fR\fIfalse\fR
\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
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
If set to "false", caching is still done but in memory\&.
.RE
+.PP
+\fBpriority=\fR\fI100\fR
+.RS 4
+Plugin priority
+.RE
.SH "QUEUE MODES"
.PP
-mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the one currently played\&.
+mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
.PP
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\&.
.PP
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\&.
.sp
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\&.
-.br
-
-It is planned to allow users to set the values of AlbumArtists tag triggering this behaviour\&. cf\&. feature request #2085 on the tracker\&.
.RE
.SH "FILES"
.PP
.PP
${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
.RS 4
-Persistant http cache\&.
+Persistent http cache\&.
.RE
.PP
Usually
${HOME}/\&.config\&.
.br
You may override them using command line option
-\fB\-\-var_dir\fR
+\fB\-\-var\-dir\fR
+and
+\fB\-\-config\fR
(cf\&.
-\fBmpd_sima\fR(1))
+\fBmpd-sima\fR(1))
.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
.RE
.SH "COPYRIGHT"
.br
-Copyright \(co 2009-2014 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)\&.
home / dev / repositories / mpd-sima.git / blobdiff