X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=62587d38d69fd6c5f60e5da162db282918cc06bc;hb=8f164c9ff754dc496eb7f9e8cf23be6062ee15d5;hp=b0df17f95adf4e4ea50e2ac3b401b6ada07d8c3a;hpb=0374809fd2dd8e22c24efc0ce08df9ceefcf01b5;p=mpd-sima.git diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg index b0df17f..62587d3 100644 --- a/doc/examples/all_settings.cfg +++ b/doc/examples/all_settings.cfg @@ -31,12 +31,29 @@ port = 6600 # ####################################################################### +########################## DAEMON SECTION ################################ +# +[daemon] +## DAEMON +# type: boolean +# description: whether to daemonize process or not +# default: False +daemon=false + +## PIDFILE +# type: string (path to the pid file) +# description: where to store process ID +# default: unset, process ID not saved to file +#pidfile= +# +####################################################################### + ######################## LOGGING FACILITY ############################# # [log] ## LOGFILE # type: string (file path) -# description: file to log to. Usually used in daemon mode. +# description: file to log to. Usually used when process is daemonized. # default: unset, logging to stdin/stdout #logfile = @@ -50,7 +67,6 @@ port = 6600 # * warning # * error verbosity = info - # ####################################################################### @@ -106,7 +122,99 @@ queue_length = 2 # description: Use of MusicBrainzIdentifier tag musicbrainzid = True +## REPEAT_DISABLE_QUEUE +# type: boolean +# default: True +# description: Prevent repeat play mode to disable queuing +repeat_disable_queue = True + +## SINGLE_DISABLE_QUEUE +# type: boolean +# default: True +# description: Prevent single play mode to disable queuing +single_disable_queue = True +# +####################################################################### + ######################### PLUGINS ##################################### +# +[genre] +## Offline genre queing + +## QUEUE_MODE +# type: string +# description: Configure queue mode, a single track or an album +# Possible values: +# track : Will queue single track artists (default). +# album : Will queue whole album from artists. +queue_mode = track + +## SINGLE_ALBUM +# type: boolean +# scope: "track" queue mode only +# description: Prevent from queueing a track from the same album (for instance +# with OST). +single_album = false + +## TRACK_TO_ADD +# type: integer +# scope: "track" and "top" queue modes +# description: how many tracks the plugin will try to get +track_to_add = 1 + +## ALBUM_TO_ADD +# type: integer +# scope: "album" queue mode +# description: how many albums the plugin will try to get +album_to_add = 1 + + +[tags] +## Offline tags queing +# This plugin has no defaults set + +# TAGS, any of the supported tags below +# type: string +# default: not set +# description: +comment= +date= +genre= +label= +originaldate= + +## FILTER +# type: string +# default: not set +# description: Forge your own MPD filter (cf MPD protocol documentation) +filter= + +## QUEUE_MODE +# type: string +# description: Configure queue mode, a single track or an album +# Possible values: +# track : Will queue single track artists (default). +# album : Will queue whole album from artists. +queue_mode = track + +## SINGLE_ALBUM +# type: boolean +# scope: "track" queue mode only +# description: Prevent from queueing a track from the same album (for instance +# with OST). +single_album = false + +## TRACK_TO_ADD +# type: integer +# scope: "track" and "top" queue modes +# description: how many tracks the plugin will try to get +track_to_add = 1 + +## ALBUM_TO_ADD +# type: integer +# scope: "album" queue mode +# description: how many albums the plugin will try to get +album_to_add = 1 [crop] ## CONSUME @@ -142,9 +250,9 @@ flavour=sensible [lastfm] ## QUEUE_MODE # type: string -# description: The default is to queue random tracks from similar artists. +# description: Does it queue a single track, top track or an album. # Possible values: -# track : Will queue tracks from similar artists (default). +# track : Will queue single tracks from similar artists (default). # top : Will queue top tracks from similar artists. # album : Will queue whole album from similar artists. queue_mode = track @@ -154,7 +262,7 @@ queue_mode = track # description: Number of similar artist to retrieve from local media library. # When set to something superior to zero, MPD_sima tries to get as much similar # artists from media library -max_art = 10 +max_art = 20 ## DEPTH # type: integer in [1, +∞] @@ -181,6 +289,19 @@ track_to_add = 1 # description: how many albums the plugin will try to get album_to_add = 1 +## TRACK_TO_ADD_FROM_ALBUM +# type: integer +# scope: "album" queue mode +# description: how many tracks from one album the plugin will try to get +# defaults to 0 to queue the whole album +track_to_add_from_album = 0 + +## SHUFFLE_ALBUM +# type: boolean +# scope: "album" queue mode +# description: should the tracks of the album be shuffled +shuffle_album = false + ## CACHE # type: boolean # description: whether or not to use on-disk persistent http cache @@ -191,7 +312,7 @@ album_to_add = 1 # * If set to "false", caching is still done but in memory. # default: True cache = True - # -####################### END OF CONFIGURATION ########################## +####################################################################### + # vim: syntax=cfg fileencoding=utf-8