X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/ce6c36be6c2df99afd01a7a602debb321322e113..fdf98378d2d8c8550661f657d30ec5186ff642f1:/examples/config.sample.in

diff --git a/examples/config.sample.in b/examples/config.sample.in
index 86e97bf..1bf4088 100644
--- a/examples/config.sample.in
+++ b/examples/config.sample.in
@@ -1,57 +1,56 @@
-# player programs
+# Sample DisOrder config file
+#
+# You WILL need to edit this from the distributed version!
+
+# Player programs
+#
+# You can add new players for other formats.  For gapless and network
+# play to work, you will need a player that can use libao and DisOrder's
+# special driver - see "LIBAO driver" in disorder_config(5)
 player *.mp3 execraw disorder-decode
 player *.ogg execraw disorder-decode
 player *.wav execraw disorder-decode
-
-# use the fs module to list files under /export/mp3.  The encoding
+player *.flac execraw disorder-decode
+
+# Track length calculators
+#
+# If you add new formats then can add a plugin module to calculate the
+# length of a track.  See disorder(3) for the interface.
+tracklength *.mp3 disorder-tracklength
+tracklength *.ogg disorder-tracklength
+tracklength *.wav disorder-tracklength
+tracklength *.flac disorder-tracklength
+
+# Use the fs module to list files under /export/mp3.  The encoding
 # is ISO-8859-1.
 collection fs ISO-8859-1 /export/mp3
 
-# don't leave a gap between tracks
+# Don't leave a gap between tracks.
 gap 0
 
-# scratch tracks
+# Scratch tracks.  You can add your own tracks here.
 scratch pkgdatadir/slap.ogg
 scratch pkgdatadir/scratch.ogg
 
-# trust the web user and root
+# Trust the web user and root.  Trusted users can stop the server or
+# pretend to be other users.
 trust www-data root
 
-# run as user jukebox
+# Run as user jukebox.  This must exist in /etc/passwd!
 user jukebox
 
-# volume control
+# Volume control settings.
+# The device name to use
 mixer /dev/mixer
+# The channel to control
 channel pcm
 
 # URL of the web interface
 url http://jukebox.anjou.terraraq.org.uk/
 
-# stopwords (i.e. ignored words) for the track search facility
+# Stopwords (i.e. ignored words) for the track search facility.
 stopword 01 02 03 04 05 06 07 08 09 10
 stopword 1 2 3 4 5 6 7 8 9
 stopword 11 12 13 14 15 16 17 18 19 20
 stopword 21 22 23 24 25 26 27 28 29 30
 stopword the a an and to too in on of we i am as im for is
-
-# namepart and transform are now filled in by default if you do not supply
-# them.  However if you supply any namepart directives then you will not
-# get any defaults at all, so you must supply the full set.  Similarly,
-# if you supply any transform directives then you must supply the full set.
-
-# Parsing of track names for the currently playing track, the recently
-# played list and the queue.
-#namepart  title   "/([0-9]+:)?([^/]+)\\.[a-zA-Z0-9]+$"     "$2"      display
-#namepart  title   "/([^/]+)\\.[a-zA-Z0-9]+$"               "$1"      sort
-#namepart  album   "/([^/]+)/[^/]+$"                        "$1"      *
-#namepart  artist  "/([^/]+)/[^/]+/[^/]+$"                  "$1"      *
-# used in alias construction
-#namepart  ext     "(\\.[a-zA-Z0-9]+)$"                     "$1"      *
-
-# Transformations of directory and filenames for the track choice screen
-#transform track   "^.*/([0-9]+:)?([^/]+)\\.[a-zA-Z0-9]+$"  "$2"      display
-#transform track   "^.*/([^/]+)\\.[a-zA-Z0-9]+$"            "$1"      sort
-
-#transform dir     "^.*/([^/]+)$"                           "$1"      *
-#transform dir     "^(the) ([^/]*)"                         "$2, $1"  sort    i
-#transform dir     "[[:punct:]]"                            ""        sort    g