X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;h=877ecedb54300b21ddf036f22d2f42a8c18cf7c5;hb=4f5c92c03e18c4052a031f2061731cab429a98fe;hp=6096153cf7aa4b2e7cdd9f9d0208cbfcf0deb752;hpb=a46c7dcaa94bad3ecfabfc16ec6dc5d04ed86d5f;p=mpd-sima.git

diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5
index 6096153..877eced 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>
+.\"    Author: kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 03/19/2019
-.\"    Manual: mpd-sima 0.15.1 User Manual
+.\"      Date: 12/15/2020
+.\"    Manual: mpd-sima 0.16.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD_SIMA\&.CFG" "5" "03/19/2019" "mpd-sima" "mpd-sima 0.15.1 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "12/15/2020" "mpd-sima" "mpd-sima 0.16.0 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
@@ -181,9 +212,7 @@ 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
-only\&.
+You can add, combine here as many plugins you want\&.
 .br
 
 The priority may be used to order them\&.
@@ -247,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:
@@ -343,9 +377,7 @@ How many track(s) to add\&. Only relevant in
 and
 \fBtrack\fR
 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\&.
+\fBtrack_to_add\fR) will be used\&.
 .RE
 .PP
 \fBalbum_to_add=\fR\fI1\fR
@@ -355,6 +387,13 @@ 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\&.
@@ -372,11 +411,73 @@ If set to "false", caching is still done but in memory\&.
 .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 ANDed\&.
+.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
@@ -440,7 +541,7 @@ and
 .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
@@ -453,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-2019 Jack Kaliko
+Copyright \(co 2009-2020 kaliko
 .br
 .PP
 This manual page was written for the Debian system (and may be used by others)\&.