Last changes... we are getting bugs fixed and ready for a 2.4 release

[clinton/abcde.git] / abcde.conf

diff --git a/abcde.conf b/abcde.conf
index 04c1cc0..c24a369 100644 (file)
--- a/abcde.conf
+++ b/abcde.conf
@@ -11,6 +11,10 @@
 # environment variable - wget will use it correctly.
 #CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
 
+# The CDDB protocol level.
+# Right now 5 is latin1 output and 6 is UTF8 encoding.
+#CDDBPROTO=6
+
 # The CDDB protocol requires hello information, including a valid username
 # and hostname. If you feel paranoid about giving away such info, edit this
 # line - the format is username@hostname.
@@ -23,6 +27,7 @@
 # are cached locally in $CDDBLOCALDIR
 #CDDBCOPYLOCAL="n"
 #CDDBLOCALDIR="$HOME/.cddb"
+#CDDBLOCALRECURSIVE="n"
 
 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
 # wish to submit your edited cddb file.
@@ -62,6 +67,7 @@
 #FLACENCODERSYNTAX=default
 #SPEEXENCODERSYNTAX=default
 #MPPENCODERSYNTAX=default
+#AACENCODERSYNTAX=default
 
 # Specify the syntax of the normalize binary here - so far only 'normalize'
 # is supported.
@@ -71,10 +77,17 @@
 # 'cdda2wav', 'dagrab', 'cddafs' (Mac OS X only) and 'flac'.
 #CDROMREADERSYNTAX=cdparanoia
 
-# CUE reader program to use.
-# Right now we only support 'mkcue', but this might change in the future.
+# CUE reader syntax for the CUE reader program to use.
+# abcde supports 2 CUE modes: 'mkcue' and 'abcde.mkcue' so you can set the
+# MKCUE variable accordingly. The 'abcde.mkcue' uses an internal
+# implementation, without the need of an external program.
 #CUEREADERSYNTAX=default
 
+# Specify the program to convert a CUE sheet back to a CD disc ID for CDDB queries.
+# Select between '/path/to/cue2discid' (provided as an example) or
+# 'abcde.cue2discid', implemented internaly.
+#CUE2DISCID=abcde.cue2discid
+
 # Keep the wav files after encoding. Set it to "y" and remove "clean" from
 # the list of default actions, since we purge the temp directory as default.
 #KEEPWAVS=n
@@ -112,6 +125,7 @@
 #FLAC=flac
 #SPEEXENC=speexenc
 #MPPENC=mppenc
+#AACENC=faac
 
 #ID3=id3
 #ID3V2=id3v2
@@ -139,7 +153,7 @@
 # if HTTPGETOPTS is empty or not defined.
 #HTTPGET=wget
 # for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
-# for wget: HTTPGETOPTS="-q -O -"
+# for wget: HTTPGETOPTS="-q -nv -O -"
 # for curl (MacOSX): HTTPGETOPTS="-f -s"
 #HTTPGETOPTS="-q -O -"
 
@@ -168,6 +182,9 @@
 # MPPENCOPTS='--xtreme --skip 20 --fade 10'
 #MPPENCOPTS=
 
+# M4A/AAC
+#AACENCOPTS=
+
 #ID3OPTS=
 #ID3V2OPTS=
 #CDPARANOIAOPTS=
@@ -188,13 +205,17 @@
 
 # Actions to take
 # Comma-separated list of one or more of the following:
-#  cddb,read,normalize,encode,tag,move,playlist,clean
+#  cddb,cue,read,normalize,encode,tag,move,playlist,clean,default
 #   encode implies read
 #   normalize implies read
 #   tag implies cddb,read,encode
 #   move implies cddb,read,encode,tag
 #   playlist implies cddb
-# The default action list is defined in the following comment.
+# An action can be added to the "default" action by specifying it along with
+# "default", without having to repeat the default ones:
+#  ACTIONS=default,playlist
+# The default action list (referenced as "default") is defined in the following
+# comment:
 #ACTIONS=cddb,read,encode,tag,move,clean
 
 # CD device you want to read from
@@ -232,6 +253,10 @@
 # Like OUTPUTFORMAT but for Various Artists discs.
 #VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
 
+# Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
+#ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
+#VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
+
 # Define how many encoders to run at once. This makes for huge speedups
 # on SMP systems. Defaults to 1. Equivalent to -j.
 #MAXPROCS=2
@@ -246,7 +271,7 @@
 #BATCHNORM=n
 
 # Enables nogap encoding when using the 'lame' encoder.
-#NOGAP
+#NOGAP=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
@@ -327,5 +352,5 @@
 #REMOTEHOSTS=foo,bar,baz,quux,qiix
 
 # Set to obtain some information about actions happening in the background
-# Useful if you have a slow network or CDDB servers seem irresponsive.
+# Useful if you have a slow network or CDDB servers seem unresponsive.
 #EXTRAVERBOSE=n