X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=26028800231969d13387552312ed01cd0e327fa4;hb=b60610b17d7affe1ab6c88687b144276874945a4;hp=345864f59509a56f2e0c8afb9f560b8418c21e7e;hpb=e703692c1f6f2cbac143c19dac2fb5800be8b6ea;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 index 345864f..2602880 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: kaliko -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/14/2020 -.\" Manual: mpd-sima 0.16.0 User Manual +.\" Generator: DocBook XSL Stylesheets v1.79.2 +.\" Date: 04/22/2021 +.\" Manual: mpd-sima 0.17.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD_SIMA\&.CFG" "5" "12/14/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" +.TH "MPD_SIMA\&.CFG" "5" "04/22/2021" "mpd-sima" "mpd-sima 0.17.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -276,6 +276,11 @@ Random plugin\*(Aqs configuration: .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: @@ -406,6 +411,52 @@ If set to "false", caching is still done but in memory\&. .RS 4 Plugin priority .RE +.SS "Genre section" +.PP +Genre plugin\*(Aqs configuration\&. +.PP +This plugin permits offline autoqueuing based on files genre tag only\&. +.PP +it will try to queue tracks base on genre tags of tracks in the queue\&. +.PP +\fB[genre]\fR +.RS 4 +.RE +.PP +\fBqueue_mode=\fR\fItrack\fR +.RS 4 +Queue mode to use among +\fItrack\fR, +\fIalbum\fR +(see +the section called \(lqQUEUE MODES\(rq +for info about queue modes)\&. +.RE +.PP +\fBsingle_album=\fR\fIfalse\fR +.RS 4 +Prevent from queueing a track from the same album (it often happens with OST)\&. +.br + +Only relevant in "track" queue mode\&. +.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 +.PP +\fBalbum_to_add=\fR\fI1\fR +.RS 4 +How many album(s) to add\&. Only relevant in +\fBalbum\fR +queue mode\&. +.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\&. @@ -416,26 +467,44 @@ This plugin permits offline autoqueuing based on files tags only\&. Supported ta \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\&. +\fB\*(Aqoriginaldate\*(Aq\fR\&. .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 ANDed\&. +All tag entries in this section are ANDed as a single MPD filter to look for titles in the library\&. Moreover, for each 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\&. +and date within 1982 through 1989\&. .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)\&. +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 +\fBqueue_mode=\fR\fItrack\fR +.RS 4 +Queue mode to use among +\fItrack\fR, +\fIalbum\fR +(see +the section called \(lqQUEUE MODES\(rq +for info about queue modes)\&. +.RE +.PP +\fBsingle_album=\fR\fIfalse\fR +.RS 4 +Prevent from queueing a track from the same album (it often happens with OST)\&. +.br + +Only relevant in "track" queue mode\&. +.RE +.PP \fBfilter=\fR .RS 4 You can use here any valid MPD filter as defined in MPD protocol documentation\&. @@ -457,15 +526,33 @@ You can use here any valid MPD filter as defined in MPD protocol documentation\& .RS 4 .RE .PP +\fBoriginaldate=\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 +.PP +\fBalbum_to_add=\fR\fI1\fR +.RS 4 +How many album(s) to add\&. Only relevant in +\fBalbum\fR +queue mode\&. +.RE .SH "QUEUE MODES" .PP -mpd\-sima offers different queue modes with lastfm plugin\&. 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 @@ -548,7 +635,7 @@ Wrote this man page and is currently leading MPD_sima project\&. .RE .SH "COPYRIGHT" .br -Copyright \(co 2009-2020 kaliko +Copyright \(co 2009-2021 kaliko .br .PP This manual page was written for the Debian system (and may be used by others)\&.