X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=d5e0c5793cb1d1f6a582aaf46724d05ca1345b0a;hb=8c72e63ba4d41c4d9722ddff3c000de314ff66dc;hp=95bc3378a3062a4a63c12d8205dc4e9502ab356a;hpb=14a769add6d435a7ad7db4d36074dc79511af4e3;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 index 95bc337..d5e0c57 100644 --- a/data/man/mpd_sima.cfg.5 +++ b/data/man/mpd_sima.cfg.5 @@ -2,12 +2,12 @@ .\" Title: mpd_sima.cfg .\" Author: Jack Kaliko .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 06/10/2014 -.\" Manual: mpd-sima 0.12.0 User Manual +.\" Date: 09/20/2015 +.\" Manual: mpd-sima 0.14.0 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" "09/20/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,7 +28,7 @@ .\" * 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 @@ -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 -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 +\fBpidfile=\fR +.RS 4 +Where to store process ID\&. .RE +.SS "sima section" .PP -\fBqueue_length=\fR\fI1\fR +Core mpd_sima\&.cfg configuration\&. +.PP +\fB[sima]\fR .RS 4 -This value triggers queue process if the play list 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,50 @@ 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 +220,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 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 -\fB[randomfallback]\fR +Random plugin\*(Aqs configuration: +.PP +\fB[random]\fR .RS 4 .RE .PP @@ -243,9 +278,14 @@ 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 -This section allows you to tweak LastFM plugin\*(Aqs configuration\&. +LastFM plugin\*(Aqs configuration\&. .PP \fB[lastfm]\fR .RS 4 @@ -275,7 +315,7 @@ When set to something superior to zero, it tries to get as much similar artists 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 @@ -313,9 +353,51 @@ $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&. 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 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 @@ -345,9 +427,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 @@ -363,7 +442,7 @@ SQLite DB file\&. .PP ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ .RS 4 -Persistant http cache\&. +Persistent http cache\&. .RE .PP Usually @@ -376,9 +455,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 +482,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-2015 Jack Kaliko .br .PP This manual page was written for the Debian system (and may be used by others)\&.