X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fexamples%2Fall_settings.cfg;h=4778e1aea2cfca30609f818b48d8ede41bb471f7;hb=23309f235879380a5ef7db3a51bda4d12e31902e;hp=9e2d87cff5557a1cf0653efb256c8453551d3838;hpb=add1bca205eb064366eb2a8cde436f47c0fc25a2;p=mpd-sima.git

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index 9e2d87c..4778e1a 100644
--- 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,20 @@ verbosity = info
 #                contrib = Scrobble, AwesomePlugin,
 #                          ExperimentalTest, AnotherTest
 # default:
+#          internal = "Crop, Lastfm, Random"
+#          contrib =
 # 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 an "[AwesomePlugin]"
-#     or "[awesomeplugin]" section (case insensitive).
+#     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.
 #
 #     Two plugins sources are available, internal and contrib
 #
-internal = Crop, Lastfm, RandomFallBack
-#contrib = PlaceHolder
+internal = Crop, Lastfm, Random
+#contrib =
 
 ## HISTORY_DURATION
 # type: integer (in hours)
@@ -94,34 +87,30 @@ 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
+#     User DB is loaded from $XDG_CONFIG_HOME/mpd_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
-##
+
+## MUSICBRAINZID
+# type: boolean
+# default: True
+# description: Use of MusicBrainzIdentifier tag
+musicbrainzid = True
 
 ######################### PLUGINS #####################################
-#
-[placeholder]
-key = Value
 
 [crop]
+## CONSUME
 # type: integer
 # default: unset, not cropping playlist
 # description: How many played tracks to keep in the playlist.
@@ -129,43 +118,46 @@ 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
 #       * sensible: use play history to filter chosen tracks
-#       * genre:    chose among the same genre as current track (using genre
+#       * genre:    # NOT IMPLEMENTED #
+#                   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
+# description: how many tracks the plugin will try to get
+# default: 1
+#track_to_add = 1
+
+
+# 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
 
-## SIMILARITY
-# type: integer in [0 100]
-# description: Similarity as a percentage of similarity between artists
-# (this is a last.fm metric)
-similarity = 15
-
-## DYNAMIC
+## MAX_ART
 # type: integer
 # 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 provided artists similarity is superior to
-#  similarity value.
-dynamic = 10
+#  artists from media library
+max_art = 10
 
 ## DEPTH
 # type: integer in [1, +∞]
@@ -173,11 +165,12 @@ dynamic = 10
 # description: TBD
 depth = 1
 
-## SINGLE_ALBUM # NOT IMPLEMENTED #
+## SINGLE_ALBUM
 # type: boolean
 # scope: "track" and "top" queue modes
-# description: Prevent from queueing a track from the same album (for instance with OST).
-single_album = true
+# description: Prevent from queueing a track from the same album (for instance
+#  with OST).
+single_album = false
 
 ## TRACK_TO_ADD
 # type: integer
@@ -191,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