X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=fb7ae4295812738bc08e6560dd0d177517aab5a0;hb=1181f263dc3b5fc3686df4d0f75da2c2a55f864c;hp=c281c9d21c527fc695d11ec25cffcc68e7f87294;hpb=7bd1cf9a791b7dc46fea0b665535996406cda819;p=mpd-sima.git

diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5
index c281c9d..fb7ae42 100644
--- a/data/man/mpd_sima.cfg.5
+++ b/data/man/mpd_sima.cfg.5
@@ -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: 06/12/2014
-.\"    Manual: mpd-sima 0.12.0 User Manual
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 02/12/2017
+.\"    Manual: mpd-sima 0.14.3 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD_SIMA\&.CFG" "5" "06/12/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "02/12/2017" "mpd-sima" "mpd-sima 0.14.3 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -53,12 +53,12 @@ history_duration=48  # 2 days
 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
@@ -127,29 +127,37 @@ Logging verbosity among
 \fIwarning\fR,
 \fIerror\fR\&.
 .RE
-.SS "sima section"
+.SS "Process daemonization"
 .PP
-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
+Where to store process ID\&.
+.RE
+.SS "sima section"
+.PP
+Core mpd_sima\&.cfg configuration\&.
+.PP
+\fB[sima]\fR
 .RS 4
-This value triggers queue process if the queue length is less than specified queue_length\&.
 .RE
 .PP
-\fBuser_db=\fR\fIfalse\fR
+\fBcontrib=\fR
 .RS 4
-Temporarily removed feature
 .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
 
@@ -159,28 +167,52 @@ Plugins list is a comma separated string list\&.
 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
-\fBLastfm\fR
-is the actual queue plugin\&.
+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
 
-Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace
-\fBLastFm\fR
-with
+.sp
+You can add here as many plugins you want, currently shipping
+\fBLastfm\fR
+and
 \fBEchoNest\fR
-to try\&.
+only\&.
+.br
+
+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
 .SS "Crop section"
 .PP
@@ -190,15 +222,20 @@ crop plugin\*(Aqs configuration:
 .RS 4
 .RE
 .PP
-\fBconsume=\fR\fI0\fR
+\fBconsume=\fR\fI10\fR
+.RS 4
+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
+.PP
+\fBpriority=\fR\fI10\fR
 .RS 4
-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\&.
+Plugin priority
 .RE
-.SS "RandomFallback section"
+.SS "Random section"
 .PP
-RandomFallback plugin\*(Aqs configuration:
+Random plugin\*(Aqs configuration:
 .PP
-\fB[randomfallback]\fR
+\fB[random]\fR
 .RS 4
 .RE
 .PP
@@ -243,6 +280,11 @@ When no similar tracks are found, falling back to random queuing\&. Different mo
 .RE
 .sp
 .RE
+.PP
+\fBpriority=\fR\fI50\fR
+.RS 4
+Plugin priority
+.RE
 .SS "LastFm section"
 .PP
 LastFM plugin\*(Aqs configuration\&.
@@ -308,11 +350,54 @@ 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
+.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\&.
@@ -345,9 +430,6 @@ For instance looking for album from "The Velvet Underground" will fetch "Last Da
 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
@@ -376,9 +458,11 @@ to
 ${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,
@@ -401,7 +485,7 @@ Wrote this man page and is currently leading MPD_sima project\&.
 .RE
 .SH "COPYRIGHT"
 .br
-Copyright \(co 2009-2014 Jack Kaliko
+Copyright \(co 2009-2017 Jack Kaliko
 .br
 .PP
 This manual page was written for the Debian system (and may be used by others)\&.