X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=2294468f51a2d401d3c951f1d1311cd2eb93a846;hb=dc148034c495f0fb68ed0549d50ecb212e4c1783;hp=aad901f9b62645f5e1fb382dfbe942e30276949b;hpb=d906b7f06726d9dd34ac9a6873bdf8fe683059d4;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 index aad901f..2294468 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 -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/28/2015 -.\" Manual: mpd-sima 0.13.1 User Manual +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 03/19/2019 +.\" Manual: mpd-sima 0.15.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD_SIMA\&.CFG" "5" "01/28/2015" "mpd-sima" "mpd-sima 0.13.1 User Manual" +.TH "MPD_SIMA\&.CFG" "5" "03/19/2019" "mpd-sima" "mpd-sima 0.15.0 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 @@ -152,28 +152,12 @@ Core mpd_sima\&.cfg configuration\&. .RS 4 .RE .PP -\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)\&. -.RE -.PP -\fBqueue_length=\fR\fI1\fR +\fBcontrib=\fR .RS 4 -This value triggers queue process if the queue length is less than specified queue_length\&. .RE .PP -\fBmusicbrainzid=\fR\fItrue\fR +\fBinternal=\fR\fILastfm, Random, Crop\fR .RS 4 -Use MusicBrainzIdentifier to search music (mainly for artists)\&. Consider using these metadata as it enhances a lot artist/album/tracks identification\&. -.br - -Default is True, switch to False if you don\*(Aqt have MusicBrainzIdentifier set for at least 80% of you music library\&. -.br - -Use Picard to tag your file: -\m[blue]\fB\%https://picard.musicbrainz.org/\fR\m[]\&. -.RE -.PP mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&. .br @@ -183,28 +167,60 @@ 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 +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 @@ -214,15 +230,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 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 @@ -267,6 +288,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\&. @@ -289,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 @@ -316,7 +342,10 @@ 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, and +\fBmax_art\fR +might be inferior lower than value set in config\&. .RE .PP \fBalbum_to_add=\fR\fI1\fR @@ -332,11 +361,17 @@ 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 last track in the queue\&. @@ -369,9 +404,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 @@ -400,9 +432,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, @@ -425,7 +459,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)\&.