X-Git-Url: https://git.hcoop.net/clinton/abcde.git/blobdiff_plain/56672932c9ab0f47d825df7d3856162b3442e390..fa3eb6ac4b1c4e28d34dc2c915ae55d76038ba42:/abcde.conf

diff --git a/abcde.conf b/abcde.conf
index cb75990..afeba9e 100644
--- a/abcde.conf
+++ b/abcde.conf
@@ -5,12 +5,18 @@
 # .abcde.conf file in your home directory.
 
 # CDDB options
+# Choose whether you want to use CDDB or Musicbrainz. Default is CDDB
+#CDDBMETHOD=cddb
 
 # 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.
 #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.
@@ -53,8 +59,8 @@
 # lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
 # 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.
+# mpcenc - encoder for MPCENCODERSYNTAX
+# default is a valid option for oggenc, lame, flac, speexenc and mpcenc.
 # Currently this affects the default location of the binary, the variable
 # to pick encoder command-line options from, and where the options are
 # given.
@@ -62,7 +68,7 @@
 #OGGENCODERSYNTAX=default
 #FLACENCODERSYNTAX=default
 #SPEEXENCODERSYNTAX=default
-#MPPENCODERSYNTAX=default
+#MPCENCODERSYNTAX=default
 #AACENCODERSYNTAX=default
 
 # Specify the syntax of the normalize binary here - so far only 'normalize'
@@ -70,13 +76,20 @@
 #NORMALIZERSYNTAX=default
 
 # CD reader program to use - currently recognized options are 'cdparanoia',
-# 'cdda2wav', 'dagrab', 'cddafs' (Mac OS X only) and 'flac'.
+# 'icedax', '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
@@ -113,13 +126,13 @@
 #OGGENC=oggenc
 #FLAC=flac
 #SPEEXENC=speexenc
-#MPPENC=mppenc
+#MPCENC=mpcenc
 #AACENC=faac
 
 #ID3=id3
-#ID3V2=id3v2
+#EYED3=eyeD3
 #CDPARANOIA=cdparanoia
-#CDDA2WAV=cdda2wav
+#CDDA2WAV=icedax
 #CDDAFS=cp
 #CDDISCID=cd-discid
 #CDDBTOOL=cddb-tool
@@ -142,7 +155,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 -"
 
@@ -166,16 +179,16 @@
 #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=
+# For the encoder options look at: mpcenc --longhelp. Set them like this:
+# MPCENCOPTS='--xtreme' if you wish to set more options then:
+# MPCENCOPTS='--xtreme --skip 20 --fade 10'
+#MPCENCOPTS=
 
 # M4A/AAC
 #AACENCOPTS=
 
 #ID3OPTS=
-#ID3V2OPTS=
+#EYED3OPTS="--set-encoding=utf16-LE"
 #CDPARANOIAOPTS=
 #CDDA2WAVOPTS=
 #CDDAFSOPTS="-f"
@@ -194,13 +207,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
@@ -256,7 +273,7 @@
 #BATCHNORM=n
 
 # Enables nogap encoding when using the 'lame' encoder.
-#NOGAP
+#NOGAP=y
 
 # 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
@@ -281,13 +298,12 @@
 # * 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 receives 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:
@@ -327,6 +343,19 @@
 #:
 #}
 
+# post_encode
+# By default it does nothing.
+# You can set some things to get abcde function in better ways:
+# * Move the resulting directory over the network
+# * Compare results with a previously made run, for tests
+# KEEP IN MIND that executables included in post_encode must be in your $PATH or
+# you have to define them with full /path/to/binary
+# Uncomment and substitute the ":" with your commands.
+#post_encode ()
+#{
+#:
+#}
+
 # If you'd like to have abcde eject the cdrom after all the tracks have been
 # read, uncomment the following line.
 #EJECTCD=y
@@ -336,6 +365,6 @@
 # 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
+# Set to 1,2, etc. to obtain some information about actions happening in the background
 # Useful if you have a slow network or CDDB servers seem unresponsive.
-#EXTRAVERBOSE=n
+#EXTRAVERBOSE=0