TRACKTOTAL written to ogg files
[abcde.git] / abcde.conf
index a144491..991bf0d 100644 (file)
@@ -1,16 +1,23 @@
-# System defaults for abcde version 2.2.x
+# System defaults for abcde version 2.6.1
 # 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
+# Choose whether you want to use CDDB or Musicbrainz. Default is CDDB
+# currently recognized options are 'cddb' and 'musicbrainz'
+#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.
@@ -23,6 +30,7 @@
 # are cached locally in $CDDBLOCALDIR
 #CDDBCOPYLOCAL="n"
 #CDDBLOCALDIR="$HOME/.cddb"
+#CDDBLOCALRECURSIVE="y"
 
 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
 # wish to submit your edited cddb file.
 #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. 
+# 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,
-# so they can be reused when ripping CDs.
+# so they can be reused when ripping CDs. (If this is set to "y" make
+# sure that CDDBLOCALRECURSIVE is also set to "y".)
 #CDDBUSELOCAL="n"
 
-# List, separated with a coma, the fields we want the parsing function to
+# 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"
-#SHOWPARSEDFIELDS=year,genre
+#SHOWCDDBFIELDS=year,genre
 
-# Specify the style of encoder to use here - 
+# 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
 # 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
+# wavpack - encoder for WVENCODERSYNTAX
+# mac - for APENCODERSYNTAX
+# faac, neroAacEnc, fdkaac - for AACENCODERSYNTAX
+# opusenc - for OPUSENCODERSYNTAX
+# default is a valid option for oggenc, lame, flac, speexenc, mpcenc, wavpack, faac and opus.
 # Currently this affects the default location of the binary, the variable
 # to pick encoder command-line options from, and where the options are
 # given.
 #OGGENCODERSYNTAX=default
 #FLACENCODERSYNTAX=default
 #SPEEXENCODERSYNTAX=default
-#MPPENCODERSYNTAX=default
+#MPCENCODERSYNTAX=default
+#WVENCODERSYNTAX=default
+#APENCODERSYNTAX=default
+#AACENCODERSYNTAX=default
+#OPUSENCODERSYNTAX=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', 'cddafs' (Mac OS X only) and 'flac'.
+# 'libcdio' (cd-paranoia),'icedax', 'cdda2wav', 'dagrab', 'pird',
+# '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
 #DISTMP3NICE=10
 
 # Paths of programs to use
+
+# Encoders:
 #LAME=lame
 #TOOLAME=toolame
 #GOGO=gogo
 #OGGENC=oggenc
 #FLAC=flac
 #SPEEXENC=speexenc
-#MPPENC=mppenc
-
+#MPCENC=mpcenc
+#WVENC=wavpack
+#APENC=mac
+#FAAC=faac
+#NEROAACENC=neroAacEnc
+#FDKAAC=fdkaac
+#OPUSENC=opusenc
+
+# Taggers, rippers, replaygain etc:
 #ID3=id3
 #ID3V2=id3v2
+#EYED3=eyeD3
 #CDPARANOIA=cdparanoia
-#CDDA2WAV=cdda2wav
+#CD_PARANOIA=cd-paranoia
+#CDDA2WAV=icedax
+#PIRD=pird
 #CDDAFS=cp
 #CDDISCID=cd-discid
 #CDDBTOOL=cddb-tool
 #MKCUE=mkcue
 #MKTOC=cdrdao
 #DIFF=diff
+#WVGAIN=wvgain
+#APETAG=apetag
+#GLYRC=glyrc
+#IDENTIFY=identify
+#CONVERT=convert
+#DISPLAYCMD=display
 
 # Options to call programs with:
 
-# If HTTPGET is modified, the HTTPGETOPTS options should also be defined 
+# If HTTPGET is modified, the HTTPGETOPTS options should also be defined
 # accordingly. If HTTPGET is changed, the default options will be set,
 # 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 -"
 
 # MP3:
+# For the best LAME encoder options have a look at:
+# <http://wiki.hydrogenaudio.org/index.php?title=LAME#Recommended_encoder_settings>
+# A good option is '-V 0' which gives Variable Bitrate Rate (VBR) recording
+# with a target bitrate of ~245 Kbps and a bitrate range of 220...260 Kbps.
 #LAMEOPTS=
 #TOOLAMEOPTS=
 #GOGOOPTS=
+# Bladeenc still works with abcde in 2015, and the last release of bladeenc
+# was in 2001! Settings that will produce a great encode are: '-br 192' 
 #BLADEENCOPTS=
+# L3enc still works with abcde in 2015, pretty amazing when you realise 
+# that the last release of l3enc was in 1997! Settings that will produce 
+# a great encode are: '-br 256000 -hq -crc'
 #L3ENCOPTS=
 #XINGMP3ENCOPTS=
+# And mp3enc also still works with abcde in 2015 with the last release
+# of mp3enc in 1998! Settings that will produce a great encode, albeit
+# a slow one, are: '-v -br 256000 -qual 9 -no-is -bw 16500'
 #MP3ENCOPTS=
 
 # Ogg:
 #OGGENCOPTS=
 
 # FLAC:
-#FLACOPTS="-f"
+# The flac option is a workaround for an error where flac fails
+# to encode with error 'floating point exception'. This is flac 
+# error in get_console_width(), corrected in flac 1.3.1
+#FLACOPTS="--silent"
 
 # 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=
-
+# For the encoder options look at 'mpcenc --longhelp', consider
+# setting '--extreme' for a good quality encode.
+#MPCENCOPTS=
+
+# WavPack:
+# Look at 'wavpack --help' for detailed options, consider using '-hx3' 
+# for a good quality encode
+#WVENCOPTS=
+# For Wavpack replay gain we set both the default of 'track gain' 
+# as well as this option for 'album gain'. Better media players
+# such as vlc can select either or neither.    
+#WVGAINOPTS='-a'
+
+# Monkey's Audio (ape)
+# Without this set mac chokes unfortunately. Choices
+# are from 1000 to 5000.
+#APENCOPTS='-c4000'
+
+# M4A/AAC
+# Note that the old AACENCOPTS has been rendered obsolete by
+# the following options, new to abcde 2.6.1:
+#  1. faac: see 'faac --long-help' and consider
+#     using '-q 250' for a good quality encode.
+#FAACENCOPTS=
+#  2. neroAacEnc: see 'neroAacEnc -help' and
+#     consider using '-q 0.65' for a good quality encode.
+#NEROAACENCOPTS=
+#  3. fdkaac: see 'fdkaac --help' and consider using 
+#     '--profile 2 --bitrate-mode 5 --afterburner 1'
+#     for a good quality encode. 
+#FDKAACENCOPTS='--bitrate 192k'
+
+# OPUS
+# For the encoder options look at: 'opusenc -h'
+#OPUSENCOPTS=
+
+# mp3 tagging:
+# There are three ways to tag MP3 files:
+#   1. id3v1 (with id3)
+#   2. id3v2.3 (with id3v2)
+#   3. id3v2.4 (with eyeD3) This is the default
+# Use ID3TAGV to select one of the older formats:
+#ID3TAGV=id3v2.4
 #ID3OPTS=
 #ID3V2OPTS=
+#EYED3OPTS="--set-encoding=utf16-LE"
+
+# Other options:
+# The variable CDPARANOIOPTS is also used by GNU's cd-paranoia,
+# so use this when setting CDROMREADERSYNTX=libcdio.
 #CDPARANOIAOPTS=
 #CDDA2WAVOPTS=
+#PIRDOPTS="-p"
 #CDDAFSOPTS="-f"
 #CDDBTOOLOPTS=
 #EJECTOPTS=
 #DIFFOPTS=""
 #VORBISCOMMENTOPTS="-R"
 #METAFLACOPTS="--no-utf8-convert"
-#DIFFOPTS=""
 
 # 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,replaygain,playlist,getalbumart,clean,default
 #   encode implies read
 #   normalize implies read
 #   tag implies cddb,read,encode
 #   move implies cddb,read,encode,tag
+#   replaygain implies cddb,read,encode,tag,move
 #   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
 # you can specify that here
 #WAVOUTPUTDIR=`pwd`
 
-# OUTPUTTYPE can be either "ogg", "mp3", "flac" or "spx", or a combination
-# of them separated with ",": "ogg,mp3".
+# OUTPUTTYPE can be any of a number of formats, either a single format
+# (e.g. "ogg") or a combination of them separated with ","
+# (e.g. "flac,mp3"). Currently recognised and supported are:
+# "flac", "m4a", "mp3, "mpc", "ogg", "opus", "spx", "vorbis", "wav", "wv", "ape"
 #OUTPUTTYPE=ogg
 
 # Output filename format - change this to reflect your inner desire to
 # organize things differently than everyone else :)
 # You have the following variables at your disposal:
-# OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, and TRACKNUM.
+# OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, TRACKNUM and YEAR.
 # Make sure to single-quote this variable. abcde will automatically create
 # the directory portion of this filename.
 # NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
 # 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
 #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
+# volume differences between tracks of an album.
+#BATCHNORM=n
+
+# Enables nogap encoding when using the 'lame' encoder.
+#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
 #(some hardware players insist on CR-LF line-endings)
 #DOSPLAYLIST=n
 
+# album art download options (see glyrc's help for details with more detailed 
+# examples here: https://github.com/sahib/glyr/wiki/Commandline-arguments).
+# For example use '--formats jpg;jpeg' to only search for JPEG images
+# These options: '--from <provider>' and '--lang <langcode>' might also be useful
+#GLYRCOPTS=
+#ALBUMARTFILE="cover.jpg"
+#ALBUMARTTYPE="JPEG"
+
+# Options for ImageMagick commands used by album art processing when available
+# For example: CONVERTOPTS="-colorspace RGB -resize 600x600>"
+# to make the image RGB and fit inside 600x600 while keeping the aspect ratio
+#IDENTIFYOPTS=
+#CONVERTOPTS=
+#DISPLAYCMDOPTS="-resize 512x512 -title abcde_album_art"
+# By default convert is only called when the image type is different from
+# ALBUMARTTYPE, use ALBUMARTALWAYSCONVERT="y" to always call convert
+#ALBUMARTALWAYSCONVERT="n"
+
 # Custom filename munging:
 # By default, abcde will do the following to CDDB data to get a useful
 # filename:
 # * 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 ot just turn the first
+# function, with not much use, but one can disable it or just turn the first
 # Uppercase.
 #mungegenre ()
 #{
 
 # Custom pre-read function
 # By default it does nothing.
-# You can set some things to get abcde funtion in better ways:
-# * Close the CD tray using eject -t (if available in eject and supported by 
+# 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 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
 
 # Custom post-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:
 # * 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
 #:
 #}
 
+# 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
 # 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
+# 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=0