X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=data%2Fman%2Fmpd_sima.cfg.5.xml;h=149087f8a2a36243215ba6e2903e0b887d578afb;hb=2bdb311df29a1524223c606e52c72d0524ed6bda;hp=97018d801ca9aca21f2c90c6cf4aef3cbf21523f;hpb=7bd1cf9a791b7dc46fea0b665535996406cda819;p=mpd-sima.git diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml index 97018d8..149087f 100644 --- a/data/man/mpd_sima.cfg.5.xml +++ b/data/man/mpd_sima.cfg.5.xml @@ -75,9 +75,15 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ --> + + File tags queue mode (offline mode). + Here is an example of autoqueue using file tags only. + + + - Album queue mode. - Here is an example of album queue configuration. + Album queue mode using last.fm recommendations (online mode). + Here is an example of album queue configuration using online recommendations system. @@ -129,8 +135,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - Configure logging. log section + Configure logging. @@ -139,7 +145,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - File to log to, usually in dæmon mode.Defaut + File to log to, usually in dæmon mode.Default (empty or unset) is to log to stdin/stdout. @@ -155,64 +161,106 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - - sima section - Core &dhutils; configuration. + + Process daemonization + Configure process daemon. - - + + - - 8 + + - 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. - - 1 + + - This value triggers queue process if the queue - length is less than specified - queue_length. - - - - false - - Temporarily removed feature - + Where to store process ID. - &dhpackage;'s plugin management for internal source plugin - and contrib (ie. external plugins). Plugins list is a - comma separated string list. Optional plugin's - configuration lays in its own section.For instance a - "AwesomePlugin" declared here gets its configuration from the - corresponding section "[awesomeplugin]".internal plugins - will look for a section named after the lower-cased name of the - pluglin, ie. RandomFallBack → randomfallback. - + + + sima section + Core &dhutils; configuration. - - Crop, RandomFallBack, Lastfm - - and - are utilities plugins while is the - actual queue plugin. Another queue plugin is available as - a "techno preview", it relies on EchoNest web services, replace - with to try. - - - - - - - + + + + + + + + + + + + Lastfm, Random, Crop + + &dhpackage;'s plugin management for internal source plugin + and contrib (ie. external plugins). Plugins list is a + comma separated string list. Optional plugin's + configuration lays in its own section.For instance a + "AwesomePlugin" declared here gets its configuration from the + corresponding section "[awesomeplugin]". + + The default list of plugins to load at startup: ,,. + is an utility plugin, it does not queue any tracks (cf. below). + will queue a track at random if other plugins did not return any tracks. + + You can add, combine here as many plugins you want. + The priority may be used to order them. + + + + + 8 + + How far to look back in history to avoid to play + twice the same track/title (duration in + hours). + The is also used to give priority to not recently played artists. + + + + + 2 + + Threshold value triggering queue process. + + + + true + + Use MusicBrainzIdentifier to search music (mainly + for artists). + Default is True, switch to False if you don't have + MusicBrainzIdentifier set for at least 80% of you + music library. Consider using these metadata as it + enhances a lot artist/album/tracks identification. + Use Picard to tag your file: . + + + + + true + + Prevent disabling queuing in repeat play mode. + + + + + true + + Prevent disabling queuing in single play mode. + + + + @@ -222,22 +270,36 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - 0 + 10 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. + Set to some negative integer to keep all played tracks. + + + + + 10 + + + Plugin priority - - RandomFallback section - RandomFallback plugin's configuration: - - + + Random section + Random plugin's configuration: + + - + + 1 + + How many track(s) to add. + + + sensible When no similar tracks are found, falling back to @@ -263,6 +325,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + + 50 + + + Plugin priority + + + LastFm section @@ -283,7 +353,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ 10 - Number of similar artist to retrieve from local + Maximum number of similar artist to retrieve from local media library.When set to something superior to zero, it tries to get as much similar artists from media library. @@ -313,7 +383,9 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ How many track(s) to add. Only relevant in and - queue modes. + queue modes. This is actually an upper limit, + min(, + ) will be used. @@ -323,6 +395,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ queue modes. + + 0 + + How many track(s) to add from each selected albums. Only relevant in + queue modes. When set to 0 or lower the whole album is queued. + + + True @@ -335,61 +415,126 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + + 100 + + + Plugin priority + + + + + Tags section + Tags plugin's configuration. There is no default configuration for this plugin, it does not work out of the box. + + This plugin permits offline autoqueuing based on files tags only. Supported tags are + , , , and + . It currently supports single track queuing only, no album mode for this plugin. + + + In addition to supported tags above you can use an MPD filter. Please refer to MPD protocol documentation for more. + + + 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. + For instance setting "" and + "" + will end up looking for track tagged with genre + and date within 1985 through 1990. + Using an MPD filter to replace you can achieve + the same with the following setting: "" and + "" (provided your MPD server + was compiled with libpcre). + + + + + + + + You can use here any valid MPD filter as defined in MPD protocol documentation. + + + + + + + + + + + + + + + + 80 + + + Plugin priority + + + + + 1 + + How many track(s) to add. + + + QUEUE MODES - &dhpackage; 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 + presence in plugin config). + &dhpackage; 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. + at least not recently played artist. - - - - Queue a similar track chosen at random from a similar artist. - - - - - - Queue a track from a similar artist, chosen among - "top tracks" according to last.fm data mining. - - - - - - Queue a whole album chosen at random from a similar artist. - Nota Bene: 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. - 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. - 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. - &dhpackage; 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't be queued. - It is planned to allow users to set the values of - AlbumArtists tag triggering this behaviour. cf. - feature request #2085 on the tracker. - - + + + + Queue a similar track chosen at random from a similar artist. + + + + + + Queue a track from a similar artist, chosen among + "top tracks" according to last.fm data mining. + + + + + + Queue a whole album chosen at random from a similar artist. + Nota Bene: 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. + 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. + 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. + &dhpackage; 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't be queued. + + +