Huge clean-up

[mpd-sima.git] / data / man / mpd_sima.cfg.5

diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5
index 95bc3378a3062a4a63c12d8205dc4e9502ab356a..aad901f9b62645f5e1fb382dfbe942e30276949b 100644 (file)
--- 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 <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 06/10/2014
-.\"    Manual: mpd-sima 0.12.0 User Manual
+.\"      Date: 01/28/2015
+.\"    Manual: mpd-sima 0.13.1 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" "01/28/2015" "mpd-sima" "mpd-sima 0.13.1 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,9 +127,26 @@ Logging verbosity among
 \fIwarning\fR,
 \fIerror\fR\&.
 .RE
+.SS "Process daemonization"
+.PP
+Configure process daemon\&.
+.PP
+\fB[daemon]\fR
+.RS 4
+.RE
+.PP
+\fBdaemon=false\fR
+.RS 4
+whether to daemonize process or not\&.
+.RE
+.PP
+\fBpidfile=\fR
+.RS 4
+Where to store process ID\&.
+.RE
 .SS "sima section"
 .PP
-This section allows you to tweak core mpd_sima\&.cfg configuration\&.
+Core mpd_sima\&.cfg configuration\&.
 .PP
 \fB[sima]\fR
 .RS 4
@@ -142,12 +159,19 @@ How far to look back in history to avoid to play twice the same track/title (dur
 .PP
 \fBqueue_length=\fR\fI1\fR
 .RS 4
-This value triggers queue process if the play list length is less than specified queue_length\&.
+This value triggers queue process if the queue length is less than specified queue_length\&.
 .RE
 .PP
-\fBuser_db=\fR\fIfalse\fR
+\fBmusicbrainzid=\fR\fItrue\fR
 .RS 4
-Temporarily removed feature
+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)\&.
@@ -192,7 +216,7 @@ crop plugin\*(Aqs configuration:
 .PP
 \fBconsume=\fR\fI0\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 0 to keep all played tracks\&.
 .RE
 .SS "RandomFallback section"
 .PP
@@ -245,7 +269,7 @@ When no similar tracks are found, falling back to random queuing\&. Different mo
 .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 +299,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
@@ -315,7 +339,7 @@ If set to "false", caching is still done but in memory\&.
 .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
@@ -363,7 +387,7 @@ SQLite DB file\&.
 .PP
 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 .RS 4
-Persistant http cache\&.
+Persistent http cache\&.
 .RE
 .PP
 Usually
@@ -401,7 +425,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)\&.