X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5;fp=data%2Fman%2Fmpd_sima.cfg.5;h=0000000000000000000000000000000000000000;hb=dd2a18ade8d2cdbd3111c4eb01cf95f4a631f8a7;hp=4816acd4169fe710aed44123d6aa6f949ad6e921;hpb=6288b079e5de8e9ee5482e8009111b6ba3cba93a;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 deleted file mode 100644 index 4816acd..0000000 --- a/data/man/mpd_sima.cfg.5 +++ /dev/null @@ -1,637 +0,0 @@ -'\" t -.\" Title: mpd_sima.cfg -.\" Author: kaliko -.\" Generator: DocBook XSL Stylesheets v1.79.2 -.\" Date: 11/16/2021 -.\" Manual: mpd-sima 0.18.0 User Manual -.\" Source: mpd-sima -.\" Language: English -.\" -.TH "MPD_SIMA\&.CFG" "5" "11/16/2021" "mpd-sima" "mpd-sima 0.18.0 User Manual" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -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 -\fBmpd\-sima\fR -configuration options available in user configuration file (see -the section called \(lqFILES\(rq)\&. -.SH "EXAMPLES" -.SS "File tags queue mode (offline mode)\&." -.PP -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 -.\} -.nf -[MPD] -host=example\&.org -port=8000 - -[sima] -history_duration=48 # 2 days -queue_length=5 - -[lastfm] -queue_mode=album -album_to_add=2 - -[crop] -# keep 30 played tracks in playlist -consume=30 - - -.fi -.if n \{\ -.RE -.\} -.SH "CONFIGURATION FILE" -.PP -The configuration file consists of sections, led by a -\fB[section]\fR -header and followed by -\fBname:\ \&value\fR -entries, with continuations in the style of RFC 822 (see section 3\&.1\&.1, \(lqLONG HEADER FIELDS\(rq); -\fBname=value\fR -is also accepted\&. Lines beginning with -\fI\*(Aq#\*(Aq\fR -or -\fI\*(Aq;\*(Aq\fR -are ignored and may be used to provide comments (\fINota Bene:\fR -inline comment are possible using -\fI\*(Aq#\*(Aq\fR)\&. -.PP -The default values are used in the options lists below\&. -.SS "MPD section" -.PP -This section is meant to configure MPD access, MPD host address / port and password if necessary\&. -.PP -\fB[MPD]\fR -.RS 4 -.RE -.PP -\fBhost=\fR\fIlocalhost\fR -.RS 4 -Set MPD host\&. Use IP or FQDN\&. -.RE -.PP -\fBport=\fR\fI6600\fR -.RS 4 -Set host port to access MPD to\&. -.RE -.PP -\fBpassword=\fR\fIs3cr3t\fR -.RS 4 -Set MPD password to use\&. Do not use this option if you don\*(Aqt have enabled password protected access on your MPD server\&. -.RE -.SS "log section" -.PP -Configure logging\&. -.PP -\fB[log]\fR -.RS 4 -.RE -.PP -\fBlogfile=\fR -.RS 4 -File to log to, usually in d\(aemon mode\&. -.br -Default (empty or unset) is to log to stdin/stdout\&. -.RE -.PP -\fBverbosity=\fR\fIinfo\fR -.RS 4 -Logging verbosity among -\fIdebug\fR, -\fIinfo\fR, -\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 -Core mpd_sima\&.cfg configuration\&. -.PP -\fB[sima]\fR -.RS 4 -.RE -.PP -\fBcontrib=\fR -.RS 4 -.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 - -Plugins list is a comma separated string list\&. -.br - -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 - -\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 -\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 -crop plugin\*(Aqs configuration: -.PP -\fB[crop]\fR -.RS 4 -.RE -.PP -\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 -Plugin priority -.RE -.SS "Random section" -.PP -When no similar tracks are found, falling back to random queuing\&. -.PP -Random plugin\*(Aqs configuration: -.PP -\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 -Different mode, aka random flavour, are available: -\fIpure\fR, -\fIsensible\fR, -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -\fIpure\fR, pure random choice, even among recently played track\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -\fIsensible\fR, use play history to filter chosen tracks\&. -.RE -.sp -.RE -.PP -\fBpriority=\fR\fI50\fR -.RS 4 -Plugin priority -.RE -.SS "LastFm section" -.PP -LastFM plugin\*(Aqs configuration\&. -.PP -\fB[lastfm]\fR -.RS 4 -.RE -.PP -\fBqueue_mode=\fR\fItrack\fR -.RS 4 -Queue mode to use among -\fItrack\fR, -\fItop\fR -and -\fIalbum\fR -(see -the section called \(lqQUEUE MODES\(rq -for info about queue modes)\&. -.RE -.PP -\fBmax_art=\fR\fI10\fR -.RS 4 -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 -.PP -\fBdepth=\fR\fI1\fR -.RS 4 -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 generates wider suggestions, it might help to reduce looping over same artists\&. -.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 -\fBtrack_to_add=\fR\fI1\fR -.RS 4 -How many track(s) to add\&. Only relevant in -\fBtop\fR -and -\fBtrack\fR -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 -.RS 4 -How many album(s) to add\&. Only relevant in -\fBalbum\fR -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_DATA_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 "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\&. -.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\&. -.PP -In addition to supported tags above you can use an MPD filter\&. Please refer to MPD protocol documentation for more\&. -.PP -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 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)\&. -.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\&. -.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 -\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 -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\&. -.PP -\fBtrack\fR -.RS 4 -Queue a similar track chosen at random from a similar artist\&. -.RE -.PP -\fBtop\fR -.RS 4 -Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&. -.RE -.PP -\fBalbum\fR -.RS 4 -Queue a whole album chosen at random from a similar artist\&. -.sp -\fINota Bene:\fR -.br - -Due to the track point of view of database build upon tracks tags an album lookup for a specific artist will return albums as soon as this artist appears in a single track of the album\&. -.br - -For instance looking for album from "The Velvet Underground" will fetch "Last Days" and "Juno" OSTs because the band appears on the soundtrack of these two movies\&. -.br - -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\&. -.RE -.SH "FILES" -.PP -${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg -.RS 4 -Configuration file\&. -.RE -.PP -${XDG_DATA_HOME}/mpd_sima/sima\&.db -.RS 4 -SQLite DB file\&. -.RE -.PP -${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ -.RS 4 -Persistent http cache\&. -.RE -.PP -Usually -\fBXDG_DATA_HOME\fR -is set to -${HOME}/\&.local/share -and -\fBXDG_CONFIG_HOME\fR -to -${HOME}/\&.config\&. -.br -You may override them using command line option -\fB\-\-var\-dir\fR -and -\fB\-\-config\fR -(cf\&. -\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\%https://kaliko.me/contact/\fR\m[]\&. -.PP -XMPP -users are welcome to join the dedicated chat room at -\m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&. -.SH "SEE ALSO" -.PP -\fBmpc\fR(1), -\fBmpd\fR(1) -.PP -/usr/share/doc/mpd\-sima/ -.SH "AUTHOR" -.PP -\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-2021 kaliko -.br -.PP -This manual page was written for the Debian system (and may be used by others)\&. -.PP -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&. -.PP -On Debian systems, the complete text of the GNU General Public License can be found in -/usr/share/common\-licenses/GPL\&. -.sp