Small fixes
[clinton/abcde.git] / abcde.conf
index 6c2fff5..68f014d 100644 (file)
@@ -1,9 +1,11 @@
-# System defaults for abcde version 2.1.x
+# System defaults for abcde version 2.2.x
 # Nothing in this file is uncommented by default.
 # 
 # If you wish to override these system-wide settings, create your own
 # .abcde.conf file in your home directory.
 
+# CDDB options
+
 # If you wish to use a different CDDB server, edit this line.
 # If you just wanted to use a proxy server, just set your http_proxy
 # environment variable - wget will use it correctly.
 #CDDBCOPYLOCAL="n"
 #CDDBLOCALDIR="$HOME/.cddb"
 
+# If NOSUBMIT is set to y, then abcde will never prompt asking if you
+# wish to submit your edited cddb file.
+#NOSUBMIT=n
+
+# If NOCDDBQUERY is set to y, then abcde will never even try to access
+# the CDDB server; running abcde will automatically drop you into a
+# blank cddb file to edit at your leisure.  This is the same as the
+# -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
+#NOCDDBQUERY=n
+
 # Select here if you want to use the locally stored CDDB entries.
 # This is useful if you do a lot of editing to those CDDB entries. 
 # Also, other tools like Grip store CDDB entries under $HOME/.cddb,
 # Specify the style of encoder to use here - 
 # oggenc, vorbize - for OGGENCODERSYNTAX
 # lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
-# flac - the only supported for FLACENCODERSYNTAX at the moment.
-# default is a valid option for oggenc, lame and flac.
+# flac - the only supported for FLACENCODERSYNTAX at the moment
+# speexenc - the only encoder for SPEEXENCODERSYNTAX
+# mppenc - encoder for MPPENCODERSYNTAX
+# default is a valid option for oggenc, lame, flac, speexenc and mppenc.
 # Currently this affects the default location of the binary, the variable
 # to pick encoder command-line options from, and where the options are
 # given.
-# 'default' will currently choose oggenc or lame depending on OUTPUTTYPE.
 #MP3ENCODERSYNTAX=default
 #OGGENCODERSYNTAX=default
 #FLACENCODERSYNTAX=default
 # 01.my_song.ext
 #PADTRACKS=n
 
+# Define if you want abcde to be non-interactive.
+# Keep in mind that there is no way to deactivate it right now in the command
+# line, so setting this option makes abcde to be always non-interactive.
+#INTERACTIVE=n
+
 # Specify 'nice'ness of the encoder, the CD reader and the distmp3 proc.
 # This is a relative 'nice'ness (that is, if the parent process is at a
 # nice level of 12, and the ENCNICE is set to 3, then the encoder will
 #MD5SUM=md5sum
 #DISTMP3=distmp3
 #VORBISCOMMENT=vorbiscomment
-#NORMALIZE=normalize
+#NORMALIZE=normalize-audio
 #CDSPEED=eject
 
 # Options to call programs with:
 #SPEEXENCOPTS=
 
 # MPP/MP+ (Musepack):
+# For the encoder options take a look at the manpage. Set them like this:
+# MPPENCOPTS='--xtreme' if you wish to set more options then:
+# MPPENCOPTS='--xtreme --skip 20 --fade 10'
 #MPPENCOPTS=
 
 #ID3OPTS=
 # The default action list is defined in the following comment.
 #ACTIONS=cddb,read,encode,tag,move,clean
 
-# CDDB options
-# If NOSUBMIT is set to y, then abcde will never prompt asking if you
-# wish to submit your edited cddb file.
-#NOSUBMIT=n
-# If NOCDDBQUERY is set to y, then abcde will never even try to access
-# the CDDB server; running abcde will automatically drop you into a
-# blank cddb file to edit at your leisure.  This is the same as the
-# -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
-#NOCDDBQUERY=n
-
 # CD device you want to read from
 #CDROM=/dev/cdrom
 
 # y:   No parallelization (rip, encode, rip, encode...)
 #LOWDISK=n
 
+# If set to y, enables batch mode normalization, which preserves relative
+# volume differences between tracks of an album. Also enables nogap encoding
+# when using the 'lame' encoder.
+#BATCH=n
+
 # Set the playlist file location format. Uses the same variables and format
 # as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
 # will be created for you and the playlist will reference files from that
 # * Translate colons to a space and a dash for Windows compatibility
 # * Eat control characters, single quotes, and question marks
 # * Translate spaces and forward slashes to underscores
+# * Translate stars into pluses.
 # To change that, redefine the mungefilename function.
 # mungefilename recieves the CDDB data (artist, track, title, whatever)
 # as $1 and outputs it on stdout.
 #mungefilename ()
 #{
-#      echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
+#      echo "$@" | sed s,:,\ -,g | tr \ /\* __+ | tr -d \'\"\?\[:cntrl:\]
 #}
 
+# Custom genre munging:
+# By default we just transform uppercase to lowercase. Not much of a fancy
+# function, with not much use, but one can disable it ot just turn the first
+# Uppercase.
+#mungegenre ()
+#{
+#      echo $CDGENRE | tr "[:upper:]" "[:lower:]"
+#}
+
+
 # Custom pre-read function
 # By default it does nothing.
 # You can set some things to get abcde funtion in better ways:
 # on the local machine (requires distmp3 to be installed on local machine and
 # distmp3host to be installed and running on all remote machines - see README)
 #REMOTEHOSTS=foo,bar,baz,quux,qiix
+
+# Set to obtain some information about actions happening in the background
+# Usefull if you have a slow network or CDDB servers seem irresponsive.
+#EXTRAVERBOSE=n