Update config example

[mpd-sima.git] / doc / examples / all_settings.cfg

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index 047ee3c95023bfacd6222d0a29728dca63b1888d..65cc61f8853b6c75725d0ef1b1cbe0b22936fa56 100644 (file)
--- a/doc/examples/all_settings.cfg
+++ b/doc/examples/all_settings.cfg
@@ -1,19 +1,10 @@
 ########################################################################
 #
-# If you need special settings, rename this file as sima.cfg within
-# your $XDG_CONFIG_HOME (default is $HOME/.config/sima/)
+# If you need special settings, rename this file as mpd_sima.cfg within
+# your $XDG_CONFIG_HOME (default is $HOME/.config/mpd_sima/)
 # You can also call it with --config option.
 #
-# Pay Attention:
-# * Inline comment are not possible
-#
-#  WRONG:
-#  host = localhost  # My host
-#
-#  OK:
-#  # My host
-#  host = localhost
-#
+# cf. man 5 mpd_sima.cfg
 ########################################################################
 
 ########################## MPD SECTION ################################
@@ -48,7 +39,6 @@ port = 6600
 # description: file to log to. Usually used in daemon mode.
 # default: unset, logging to stdin/stdout
 #logfile =
-##
 
 ## VERBOSITY
 # type: string
@@ -60,7 +50,6 @@ port = 6600
 #    * warning
 #    * error
 verbosity = info
-##
 
 #
 #######################################################################
@@ -76,16 +65,27 @@ verbosity = info
 #                contrib = Scrobble, AwesomePlugin,
 #                          ExperimentalTest, AnotherTest
 # default:
+#          internal = "Lastfm, Random, Crop"
+#          contrib =
+#
+# Possible values for internal
+#      Lastfm   : Queue using last.fm web service for suggestions.
+#      EchoNest : Queue using EchoNest web service for suggestions.
+#      Random   : Queue a track at random (different flavour, cf. documentation)
+#      Crop     : Remove old tracks from queue
+#
 # description: Plugins list declaration.
-#     Optional plugin's configuration must be in its own section.
+#     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. AwesomePlugin → awesomeplugin.
 #
 #     Two plugins sources are available, internal and contrib
 #
-internal = Crop, Lastfm, RandomFallBack
-#contrib = PlaceHolder
+internal = Lastfm, Random, Crop
+#contrib =
 
 ## HISTORY_DURATION
 # type: integer (in hours)
@@ -94,32 +94,20 @@ internal = Crop, Lastfm, RandomFallBack
 #     track/title
 #
 history_duration = 8
-##
-
-## USER_DB # NOT IMPLEMENTED #
-# type: boolean
-# description: Load user database to find similar artists
-#     User DB is loaded from $XDG_CONFIG_HOME/sima/sima.db
-#     Use simadb_cli to edit/add entries.
-user_db = false
-##
-
-#####################################################################
-# You do not need to set up options below.
-# But well, you got bored of the way sima is behaving, then go ahead
-# play with it :)
 
 ## 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
+# default: True
+# description: Use of MusicBrainzIdentifier tag
+musicbrainzid = True
 
 ######################### PLUGINS #####################################
-#
-[placeholder]
-key = Value
 
 [crop]
 ## CONSUME
@@ -130,12 +118,11 @@ key = Value
 #  Leave commented to keep all tracks
 #consume = 10
 
-[randomfallback]
+[random]
 ## FLAVOUR
 # type: string
 # default: sensible
-# description: When no similar tracks are found, falling back to random
-#     queuing. Different mode, aka random flavour, are available.
+# description: Random queuing, different mode, aka random flavour, are available.
 #     random flavour :
 #       * pure:     complete random choice among all tracks available in the
 #                   player media library
@@ -144,7 +131,7 @@ key = Value
 #                   chose among the same genre as current track (using genre
 #                   tag). If no genre tag is available "sensible" flavour
 #                   is used  instead
-#flavour=sensible
+flavour=sensible
 
 ## TRACK_TO_ADD
 # type: integer
@@ -153,15 +140,15 @@ key = Value
 #track_to_add = 1
 
 
-# EchoNest or LastFM
+# EchoNest or Lastfm
 #[echonest]
 [lastfm]
-## QUEUE_MODE # NOT COMPLETED #
+## QUEUE_MODE
 # type: string
 # description: The default is to queue random tracks from similar artists.
 # Possible values:
 #      track : Will queue tracks from similar artists (default).
-#      top   : Will queue top tracks from similar artists. # NOT IMPLEMENTED #
+#      top   : Will queue top tracks from similar artists.
 #      album : Will queue whole album from similar artists.
 queue_mode = track
 
@@ -197,10 +184,18 @@ track_to_add = 1
 # description: how many albums the plugin will try to get
 album_to_add = 1
 
-#
-#######################################################################
+## CACHE
+# type: boolean
+# description: whether or not to use on-disk persistent http cache
+#  * When set to "true", sima will use a persistent cache for its http client.
+#    The cache is written along with the dbfile in:
+#                $XDG_CONFIG_HOME/mpd_sima/http/<web_service>
+#    Toggling http cache is only available for last.fm. EchoNest have rate limits,
+#    we must then pay attention to bandwidth and use of caching is required.
+#  * If set to "false", caching is still done but in memory.
+# default: True
+cache = True
 
 #
 ####################### END OF CONFIGURATION ##########################
-
 # vim: syntax=cfg fileencoding=utf-8