X-Git-Url: https://git.hcoop.net/clinton/abcde.git/blobdiff_plain/c9c2ca2730a901eb83ebbdb15522bd2a5849b64f..3b4d8f9b5214afc50dad321b2393348c8d382d7f:/abcde.conf

diff --git a/abcde.conf b/abcde.conf
index 4a35f60..8a7fcda 100644
--- a/abcde.conf
+++ b/abcde.conf
@@ -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.
@@ -21,6 +23,17 @@
 # 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.
+#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. 
@@ -28,28 +41,41 @@
 # so they can be reused when ripping CDs.
 #CDDBUSELOCAL="n"
 
+# List, separated with a comma, the fields we want the parsing function to
+# output. Defaults to YEAR and GENRE, for a complete list of fields provided by
+# CDDB.
+# The fields are not case sensitive. Actually, "y,g" will work as fine as "Y,G"
+# or "YEAR, GENRE"
+#SHOWCDDBFIELDS=year,genre
+
 # 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
 #SPEEXENCODERSYNTAX=default
+#MPPENCODERSYNTAX=default
 
 # Specify the syntax of the normalize binary here - so far only 'normalize'
 # is supported.
 #NORMALIZERSYNTAX=default
 
 # CD reader program to use - currently recognized options are 'cdparanoia',
-# 'cdda2wav', 'dagrab' and 'cddafs' (Mac OS X only).
+# '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.
+#CUEREADERSYNTAX=default
+
 # 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
@@ -59,6 +85,11 @@
 # 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
@@ -71,6 +102,7 @@
 
 # Paths of programs to use
 #LAME=lame
+#TOOLAME=toolame
 #GOGO=gogo
 #BLADEENC=bladeenc
 #L3ENC=l3enc
@@ -80,6 +112,8 @@
 #OGGENC=oggenc
 #FLAC=flac
 #SPEEXENC=speexenc
+#MPPENC=mppenc
+
 #ID3=id3
 #ID3V2=id3v2
 #CDPARANOIA=cdparanoia
@@ -91,8 +125,13 @@
 #MD5SUM=md5sum
 #DISTMP3=distmp3
 #VORBISCOMMENT=vorbiscomment
-#NORMALIZE=normalize
+#METAFLAC=metaflac
+#NORMALIZE=normalize-audio
 #CDSPEED=eject
+#VORBISGAIN=vorbisgain
+#MKCUE=mkcue
+#MKTOC=cdrdao
+#DIFF=diff
 
 # Options to call programs with:
 
@@ -107,6 +146,7 @@
 
 # MP3:
 #LAMEOPTS=
+#TOOLAMEOPTS=
 #GOGOOPTS=
 #BLADEENCOPTS=
 #L3ENCOPTS=
@@ -118,11 +158,17 @@
 #OGGENCOPTS=
 
 # FLAC:
-#FLACOPTS=
+#FLACOPTS="-f"
 
 # Speex:
 #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=
 #ID3V2OPTS=
 #CDPARANOIAOPTS=
@@ -134,6 +180,12 @@
 #NORMALIZEOPTS=
 #CDSPEEDOPTS="-x"
 #CDSPEEDVALUE=""
+#MKCUEOPTS=""
+#MKTOCOPTS=""
+#DIFFOPTS=""
+#VORBISCOMMENTOPTS="-R"
+#METAFLACOPTS="--no-utf8-convert"
+#DIFFOPTS=""
 
 # Actions to take
 # Comma-separated list of one or more of the following:
@@ -146,18 +198,13 @@
 # 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
+# It can be defined as a singletrack flac file, but since it might change from
+# file to file it makes little sense to define it here.
 #CDROM=/dev/cdrom
+# If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
+# If we are using the ide-scsi emulation layer, we need to define a "g"
+#CDPARANOIACDROMBUS="d"
 
 # If you'd like to make a default location that overrides the current
 # directory for putting mp3's, uncomment this.
@@ -184,7 +231,7 @@
 #OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
 
 # Like OUTPUTFORMAT but for Various Artists discs.
-#VAOUTPUTFORMAT='${ARTISTFILE}/${TRACKFILE}'
+#VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
 
 # Define how many encoders to run at once. This makes for huge speedups
 # on SMP systems. Defaults to 1. Equivalent to -j.
@@ -195,6 +242,13 @@
 # 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. 
+#BATCHNORM=n
+
+# Enables nogap encoding when using the 'lame' encoder.
+#NOGAP
+
 # 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
@@ -209,7 +263,7 @@
 #VAPLAYLISTDATAPREFIX=''
 
 #This will give the playlist CR-LF line-endings, if set to "y".
-#(some hardware players insist on CR-LF line-endings
+#(some hardware players insist on CR-LF line-endings)
 #DOSPLAYLIST=n
 
 # Custom filename munging:
@@ -218,26 +272,52 @@
 # * 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)
+# 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:
+# By default we just transform uppercase to lowercase. Not much of a fancy
+# function, with not much use, but one can disable it or 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:
+# You can set some things to get abcde function in better ways:
 # * Close the CD tray using eject -t (if available in eject and supported by 
 #   your CD device.
 # * Set the CD speed. You can also use the built-in options, but you can also 
 #   set it here. In Debian, eject -x and cdset -x do the job.
+# KEEP IN MIND that executables included in pre_read must be in your $PATH or
+# you have to define them with full /path/to/binary
+# Uncomment and substitute the ":" with your commands.
 #pre_read ()
 #{
 #:
 #}
 
+# Custom post-read function
+# By default it does nothing.
+# You can set some things to get abcde function in better ways:
+# * Store a copy of the CD TOC.
+# KEEP IN MIND that executables included in post_read must be in your $PATH or
+# you have to define them with full /path/to/binary
+# Uncomment and substitute the ":" with your commands.
+#post_read ()
+#{
+#:
+#}
+
 # If you'd like to have abcde eject the cdrom after all the tracks have been
 # read, uncomment the following line.
 #EJECTCD=y
@@ -246,3 +326,7 @@
 # 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
+# Useful if you have a slow network or CDDB servers seem unresponsive.
+#EXTRAVERBOSE=n