From 0bca6ee3dd5a5426c985e85e0e50fac77e4ec8f1 Mon Sep 17 00:00:00 2001 From: kaliko Date: Sun, 8 Feb 2015 16:30:37 +0100 Subject: [PATCH] Update manuals --- data/man/files.xml | 2 +- data/man/mpd-sima.1 | 8 +- data/man/mpd_sima.cfg.5 | 139 ++++++++++++++++++++++++---------- data/man/mpd_sima.cfg.5.xml | 132 ++++++++++++++++++++++---------- data/man/simadb_cli.1 | 6 +- doc/examples/all_settings.cfg | 12 +-- sima/utils/config.py | 3 +- 7 files changed, 207 insertions(+), 95 deletions(-) diff --git a/data/man/files.xml b/data/man/files.xml index 381b223..806d5de 100644 --- a/data/man/files.xml +++ b/data/man/files.xml @@ -25,7 +25,7 @@ ${HOME}/.local/share and XDG_CONFIG_HOME to ${HOME}/.config.You may override them using command line option (cf. - mpd_sima + mpd-sima 1) + + + + + + + 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 here as many plugins you want, + currently shipping and + only. + 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). + hours). + The is also used to give priority to not recently played artists. + - 1 + 2 - This value triggers queue process if the queue - length is less than specified - queue_length. + Threshold value triggering queue process. true Use MusicBrainzIdentifier to search music (mainly - for artists). Consider using these metadata as it - enhances a lot artist/album/tracks identification. + for artists). Default is True, switch to False if you don't have MusicBrainzIdentifier set for at least 80% of you - music library. + music library. Consider using these metadata as it + enhances a lot artist/album/tracks identification. Use Picard to tag your file: . - &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 - plugin, ie. Random → random. - - - - Crop, Random, 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. - - - - - - - - @@ -258,6 +260,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + + 10 + + + Plugin priority + + + Random section @@ -291,6 +301,14 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + + 50 + + + Plugin priority + + + LastFm section @@ -363,6 +381,47 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + + 100 + + + Plugin priority + + + + + + + EchoNest section + EchoNest plugin's configuration. + Options for EchoNest are exactly the same as LastFm (same + default as well), except for cache plugin which is always + needed to limit number of requests to the service. + + + + + + track + + + 10 + + + 1 + + + false + + + 1 + + + 1 + + + 100 + @@ -409,10 +468,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ 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. + is skipped and won't be queued. diff --git a/data/man/simadb_cli.1 b/data/man/simadb_cli.1 index c2c5172..19a4fe9 100644 --- a/data/man/simadb_cli.1 +++ b/data/man/simadb_cli.1 @@ -2,12 +2,12 @@ .\" Title: simadb_cli .\" Author: Jack Kaliko .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/28/2015 -.\" Manual: mpd-sima 0.13.1 User Manual +.\" Date: 02/08/2015 +.\" Manual: mpd-sima 0.14.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "SIMADB_CLI" "1" "01/28/2015" "mpd-sima" "mpd-sima 0.13.1 User Manual" +.TH "SIMADB_CLI" "1" "02/08/2015" "mpd-sima" "mpd-sima 0.14.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index 4778e1a..ca8e9e6 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -65,7 +65,7 @@ verbosity = info # contrib = Scrobble, AwesomePlugin, # ExperimentalTest, AnotherTest # default: -# internal = "Crop, Lastfm, Random" +# internal = "Lastfm, Random, Crop" # contrib = # description: Plugins list declaration. # Optional plugin's configuration lays in its own section. @@ -73,11 +73,11 @@ verbosity = info # 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. Random → random. +# of the plugin, ie. AwesomePlugin → awesomeplugin. # # Two plugins sources are available, internal and contrib # -internal = Crop, Lastfm, Random +internal = Lastfm, Random, Crop #contrib = ## HISTORY_DURATION @@ -97,9 +97,9 @@ user_db = false ## QUEUE_LENGTH # type: integer -# default: 1 -# description: Queue length triggering tracks addition -queue_length = 1 +# default: 2 +# description: Queue length threshold triggering tracks addition +queue_length = 2 ## MUSICBRAINZID # type: boolean diff --git a/sima/utils/config.py b/sima/utils/config.py index d3bcbe2..f7ec982 100644 --- a/sima/utils/config.py +++ b/sima/utils/config.py @@ -46,7 +46,7 @@ DEFAULT_CONF = { 'port': 6600, }, 'sima': { - 'internal': "Crop, Lastfm, RandomFallBack", + 'internal': "Crop, Lastfm, Random", 'contrib': "", 'user_db': "false", 'history_duration': 8, @@ -64,6 +64,7 @@ DEFAULT_CONF = { }, 'crop': { 'consume': 10, + 'priority': 0, }, 'echonest': { 'queue_mode': "track", #TODO control values -- 2.39.5