X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=d8482193d6b66d916931584324e3e219ff661783;hb=2e12fc88352c4538a463b3fb02611eca3f601d5a;hp=48c882dcfdf03db501a95a0427bffdb2acae311d;hpb=28745ed78f2c3020f35268e7609cf937c9fd5175;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 index 48c882d..d848219 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: 06/11/2014 -.\" Manual: mpd-sima 0.12.0 User Manual +.\" Author: kaliko +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 12/16/2020 +.\" Manual: mpd-sima 0.16.1 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD_SIMA\&.CFG" "5" "06/11/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual" +.TH "MPD_SIMA\&.CFG" "5" "12/16/2020" "mpd-sima" "mpd-sima 0.16.1 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -36,9 +36,40 @@ This manual page documents briefly configuration options available in user configuration file (see the section called \(lqFILES\(rq)\&. .SH "EXAMPLES" -.SS "Album queue mode\&." +.SS "File tags queue mode (offline mode)\&." .PP -Here is an example of album queue configuration\&. +Here is an example of autoqueue using file tags only\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +[MPD] +host=example\&.org +port=6601 + +[sima] +# Setup internal plugins +internal = Tags, Crop +history_duration=48 # 2 days +queue_length=2 + +[tags] +# Look for files with tagged with genre "electonica" OR "IDM" OR "glitch" +genre = electonica, IDM, glitch + +[crop] +# keep 30 played tracks in playlist +consume=30 + + +.fi +.if n \{\ +.RE +.\} +.SS "Album queue mode using last\&.fm recommendations (online mode)\&." +.PP +Here is an example of album queue configuration using online recommendations system\&. .sp .if n \{\ .RS 4 @@ -53,12 +84,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 @@ -116,7 +147,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 @@ -127,29 +158,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 -\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 +198,58 @@ 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 + +\fBCrop\fR +is an utility plugin, it does not queue any tracks (cf\&. below)\&. .br -internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&. + +\fBRandom\fR +will queue a track at random if other plugins did not return any tracks\&. +.br + +.sp +You can add, combine here as many plugins you want\&. +.br + +The priority may be used to order them\&. +.RE .PP -\fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR +\fBhistory_duration=\fR\fI8\fR .RS 4 -\fBCrop\fR -and -\fBRandomFallback\fR -are utilities plugins while -\fBLastfm\fR -is the actual queue plugin\&. +How far to look back in history to avoid to play twice the same track/title (duration in hours)\&. .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 +\fBhistory_duration\fR +is also used to give priority to not recently played artists\&. .RE .PP -\fBcontrib=\fR +\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 @@ -190,18 +259,28 @@ 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\&. Allow 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 +\fBtrack_to_add=\fR\fI1\fR +.RS 4 +How many track(s) to add\&. +.RE +.PP \fBflavour=\fR\fIsensible\fR .RS 4 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available: @@ -243,9 +322,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 @@ -265,7 +349,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 @@ -275,7 +359,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 @@ -292,7 +376,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 @@ -302,22 +387,97 @@ 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 If set to "false", caching is still done but in memory\&. .RE +.PP +\fBpriority=\fR\fI100\fR +.RS 4 +Plugin priority +.RE +.SS "Tags section" +.PP +Tags plugin\*(Aqs configuration\&. There is no default configuration for this plugin, it does not work out of the box\&. +.PP +This plugin permits offline autoqueuing based on files tags only\&. Supported tags are +\fB\*(Aqcomment\*(Aq\fR, +\fB\*(Aqdate\*(Aq\fR, +\fB\*(Aqgenre\*(Aq\fR, +\fB\*(Aqlabel\*(Aq\fR +and +\fB\*(Aqoriginaldate\*(Aq\fR\&. It currently supports single track queuing only, no album mode for this plugin\&. +.PP +In addition to supported tags above you can use an MPD filter\&. Please refer to MPD protocol documentation for more\&. +.PP +All entries in this section are ANDed as a single MPD filter to look for titles in the library\&. Moreover, with tags, comma separated values are also ORed\&. +.br + +For instance setting "\fBgenre=rock\fR" and "\fBdate=1982,1983,1984,1985,1986,1987,1988,1989\fR" will end up looking for track tagged with genre +\fBrock\fR +and date within 1985 through 1990\&. +.br + +Using an MPD filter to replace +\fBdate\fR +you can achieve the same with the following setting: "\fBgenre=rock\fR" and "\fBfilter=(date =~ \*(Aq198[2\-9]+\*(Aq)\fR" (provided your MPD server was compiled with libpcre)\&. +.PP +\fB[tags]\fR +.RS 4 +.RE +.PP +\fBfilter=\fR +.RS 4 +You can use here any valid MPD filter as defined in MPD protocol documentation\&. +.RE +.PP +\fBcomment=\fR +.RS 4 +.RE +.PP +\fBdate=\fR +.RS 4 +.RE +.PP +\fBgenre=\fR +.RS 4 +.RE +.PP +\fBlabel=\fR +.RS 4 +.RE +.PP +\fBpriority=\fR\fI80\fR +.RS 4 +Plugin priority +.RE +.PP +\fBtrack_to_add=\fR\fI1\fR +.RS 4 +How many track(s) to add\&. +.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\&. +Different queue modes are available with some plugins (check for +\fBqueue_mode\fR +presence in plugin config)\&. .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\&. +mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&. .PP \fBtrack\fR .RS 4 @@ -345,9 +505,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 +520,7 @@ SQLite DB file\&. .PP ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ .RS 4 -Persistant http cache\&. +Persistent http cache\&. .RE .PP Usually @@ -376,13 +533,15 @@ 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, -\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 @@ -395,13 +554,13 @@ users are welcome to join the dedicated chat room at /usr/share/doc/mpd\-sima/ .SH "AUTHOR" .PP -\fBJack Kaliko\fR <\&kaliko@azylum\&.org\&> +\fBkaliko\fR <\&kaliko@azylum\&.org\&> .RS 4 Wrote this man page and is currently leading MPD_sima project\&. .RE .SH "COPYRIGHT" .br -Copyright \(co 2009-2014 Jack Kaliko +Copyright \(co 2009-2020 kaliko .br .PP This manual page was written for the Debian system (and may be used by others)\&.