Check that we have $CDDBTOOL before we start. (Closes issue 27).
[clinton/abcde.git] / abcde.conf
CommitLineData
72d7162b 1# System defaults for abcde version 2.2.x
c9c2ca27 2# Nothing in this file is uncommented by default.
3#
4# If you wish to override these system-wide settings, create your own
5# .abcde.conf file in your home directory.
6
81bc6204 7# CDDB options
2c2dffe6
E
8# Choose whether you want to use CDDB or Musicbrainz. Default is CDDB
9#CDDBMETHOD=cddb
81bc6204 10
c9c2ca27 11# If you wish to use a different CDDB server, edit this line.
12# If you just wanted to use a proxy server, just set your http_proxy
13# environment variable - wget will use it correctly.
14#CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
15
f7c6d185 16# The CDDB protocol level.
17# Right now 5 is latin1 output and 6 is UTF8 encoding.
18#CDDBPROTO=6
19
c9c2ca27 20# The CDDB protocol requires hello information, including a valid username
21# and hostname. If you feel paranoid about giving away such info, edit this
22# line - the format is username@hostname.
23#HELLOINFO="`whoami`@`hostname`"
24
25# This controls the email address CDDB changes are submitted to.
26#CDDBSUBMIT=freedb-submit@freedb.org
27
28# The following options control whether or not fetched CDDB entries
29# are cached locally in $CDDBLOCALDIR
30#CDDBCOPYLOCAL="n"
31#CDDBLOCALDIR="$HOME/.cddb"
6d81edb6 32#CDDBLOCALRECURSIVE="n"
c9c2ca27 33
81bc6204 34# If NOSUBMIT is set to y, then abcde will never prompt asking if you
35# wish to submit your edited cddb file.
36#NOSUBMIT=n
37
38# If NOCDDBQUERY is set to y, then abcde will never even try to access
39# the CDDB server; running abcde will automatically drop you into a
40# blank cddb file to edit at your leisure. This is the same as the
41# -n option. NOCDDBQUERY=y implies NOSUBMIT=y.
42#NOCDDBQUERY=n
43
c9c2ca27 44# Select here if you want to use the locally stored CDDB entries.
45# This is useful if you do a lot of editing to those CDDB entries.
46# Also, other tools like Grip store CDDB entries under $HOME/.cddb,
47# so they can be reused when ripping CDs.
48#CDDBUSELOCAL="n"
49
8fe929a7 50# List, separated with a comma, the fields we want the parsing function to
9ff5088c 51# output. Defaults to YEAR and GENRE, for a complete list of fields provided by
52# CDDB.
53# The fields are not case sensitive. Actually, "y,g" will work as fine as "Y,G"
54# or "YEAR, GENRE"
8fe929a7 55#SHOWCDDBFIELDS=year,genre
9ff5088c 56
c9c2ca27 57# Specify the style of encoder to use here -
58# oggenc, vorbize - for OGGENCODERSYNTAX
59# lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
12c5d978 60# flac - the only supported for FLACENCODERSYNTAX at the moment
61# speexenc - the only encoder for SPEEXENCODERSYNTAX
62# mppenc - encoder for MPPENCODERSYNTAX
63# default is a valid option for oggenc, lame, flac, speexenc and mppenc.
c9c2ca27 64# Currently this affects the default location of the binary, the variable
65# to pick encoder command-line options from, and where the options are
66# given.
c9c2ca27 67#MP3ENCODERSYNTAX=default
68#OGGENCODERSYNTAX=default
69#FLACENCODERSYNTAX=default
70#SPEEXENCODERSYNTAX=default
99d009fa 71#MPPENCODERSYNTAX=default
56672932 72#AACENCODERSYNTAX=default
c9c2ca27 73
74# Specify the syntax of the normalize binary here - so far only 'normalize'
75# is supported.
76#NORMALIZERSYNTAX=default
77
78# CD reader program to use - currently recognized options are 'cdparanoia',
6b005b85 79# 'icedax', 'cdda2wav', 'dagrab', 'cddafs' (Mac OS X only) and 'flac'.
c9c2ca27 80#CDROMREADERSYNTAX=cdparanoia
81
581a2153 82# CUE reader syntax for the CUE reader program to use.
83# abcde supports 2 CUE modes: 'mkcue' and 'abcde.mkcue' so you can set the
84# MKCUE variable accordingly. The 'abcde.mkcue' uses an internal
85# implementation, without the need of an external program.
f00ed3e7 86#CUEREADERSYNTAX=default
87
581a2153 88# Specify the program to convert a CUE sheet back to a CD disc ID for CDDB queries.
89# Select between '/path/to/cue2discid' (provided as an example) or
90# 'abcde.cue2discid', implemented internaly.
91#CUE2DISCID=abcde.cue2discid
92
c9c2ca27 93# Keep the wav files after encoding. Set it to "y" and remove "clean" from
94# the list of default actions, since we purge the temp directory as default.
95#KEEPWAVS=n
96
97# Track padding: force abcde to pad tracks using 0, so every song uses a two
98# digit entry. If set to "y", even a single song encoding outputs a file like
99# 01.my_song.ext
100#PADTRACKS=n
101
d0491de2 102# Define if you want abcde to be non-interactive.
103# Keep in mind that there is no way to deactivate it right now in the command
104# line, so setting this option makes abcde to be always non-interactive.
105#INTERACTIVE=n
106
c9c2ca27 107# Specify 'nice'ness of the encoder, the CD reader and the distmp3 proc.
108# This is a relative 'nice'ness (that is, if the parent process is at a
109# nice level of 12, and the ENCNICE is set to 3, then the encoder will
110# run with an absolute nice value of 15. Note also, that setting these
111# to be empty will result in some default niceness increase (4 in tcsh
112# and 10 using the bsdutils' nice).
113#ENCNICE=10
114#READNICE=10
115#DISTMP3NICE=10
116
117# Paths of programs to use
118#LAME=lame
c1bbe6c3 119#TOOLAME=toolame
c9c2ca27 120#GOGO=gogo
121#BLADEENC=bladeenc
122#L3ENC=l3enc
123#XINGMP3ENC=xingmp3enc
124#MP3ENC=mp3enc
125#VORBIZE=vorbize
126#OGGENC=oggenc
127#FLAC=flac
128#SPEEXENC=speexenc
9f659ada 129#MPPENC=mppenc
56672932 130#AACENC=faac
9f659ada 131
c9c2ca27 132#ID3=id3
133#ID3V2=id3v2
134#CDPARANOIA=cdparanoia
6b005b85 135#CDDA2WAV=icedax
c9c2ca27 136#CDDAFS=cp
137#CDDISCID=cd-discid
138#CDDBTOOL=cddb-tool
139#EJECT=eject
140#MD5SUM=md5sum
141#DISTMP3=distmp3
142#VORBISCOMMENT=vorbiscomment
c008b56d 143#METAFLAC=metaflac
72d7162b 144#NORMALIZE=normalize-audio
c9c2ca27 145#CDSPEED=eject
6119aaa1 146#VORBISGAIN=vorbisgain
147#MKCUE=mkcue
9ff5088c 148#MKTOC=cdrdao
149#DIFF=diff
c9c2ca27 150
151# Options to call programs with:
152
153# If HTTPGET is modified, the HTTPGETOPTS options should also be defined
154# accordingly. If HTTPGET is changed, the default options will be set,
155# if HTTPGETOPTS is empty or not defined.
156#HTTPGET=wget
157# for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
e823b911 158# for wget: HTTPGETOPTS="-q -nv -O -"
c9c2ca27 159# for curl (MacOSX): HTTPGETOPTS="-f -s"
160#HTTPGETOPTS="-q -O -"
161
162# MP3:
163#LAMEOPTS=
c1bbe6c3 164#TOOLAMEOPTS=
c9c2ca27 165#GOGOOPTS=
166#BLADEENCOPTS=
167#L3ENCOPTS=
168#XINGMP3ENCOPTS=
169#MP3ENCOPTS=
170
171# Ogg:
172#VORBIZEOPTS=
173#OGGENCOPTS=
174
175# FLAC:
da01ddc3 176#FLACOPTS="-f"
c9c2ca27 177
178# Speex:
179#SPEEXENCOPTS=
180
99d009fa 181# MPP/MP+ (Musepack):
12c5d978 182# For the encoder options take a look at the manpage. Set them like this:
183# MPPENCOPTS='--xtreme' if you wish to set more options then:
184# MPPENCOPTS='--xtreme --skip 20 --fade 10'
99d009fa 185#MPPENCOPTS=
186
56672932 187# M4A/AAC
188#AACENCOPTS=
189
c9c2ca27 190#ID3OPTS=
191#ID3V2OPTS=
192#CDPARANOIAOPTS=
193#CDDA2WAVOPTS=
194#CDDAFSOPTS="-f"
195#CDDBTOOLOPTS=
196#EJECTOPTS=
197#DISTMP3OPTS=
198#NORMALIZEOPTS=
199#CDSPEEDOPTS="-x"
200#CDSPEEDVALUE=""
6119aaa1 201#MKCUEOPTS=""
9ff5088c 202#MKTOCOPTS=""
203#DIFFOPTS=""
6119aaa1 204#VORBISCOMMENTOPTS="-R"
205#METAFLACOPTS="--no-utf8-convert"
c1bbe6c3 206#DIFFOPTS=""
c9c2ca27 207
208# Actions to take
209# Comma-separated list of one or more of the following:
f7c6d185 210# cddb,cue,read,normalize,encode,tag,move,playlist,clean,default
c9c2ca27 211# encode implies read
212# normalize implies read
213# tag implies cddb,read,encode
214# move implies cddb,read,encode,tag
215# playlist implies cddb
f7c6d185 216# An action can be added to the "default" action by specifying it along with
217# "default", without having to repeat the default ones:
218# ACTIONS=default,playlist
219# The default action list (referenced as "default") is defined in the following
220# comment:
c9c2ca27 221#ACTIONS=cddb,read,encode,tag,move,clean
222
c9c2ca27 223# CD device you want to read from
1b94d6b7 224# It can be defined as a singletrack flac file, but since it might change from
225# file to file it makes little sense to define it here.
c9c2ca27 226#CDROM=/dev/cdrom
c008b56d 227# If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
228# If we are using the ide-scsi emulation layer, we need to define a "g"
229#CDPARANOIACDROMBUS="d"
c9c2ca27 230
231# If you'd like to make a default location that overrides the current
232# directory for putting mp3's, uncomment this.
233#OUTPUTDIR=`pwd`
234
235# Or if you'd just like to put the temporary .wav files somewhere else
236# you can specify that here
237#WAVOUTPUTDIR=`pwd`
238
239# OUTPUTTYPE can be either "ogg", "mp3", "flac" or "spx", or a combination
240# of them separated with ",": "ogg,mp3".
241#OUTPUTTYPE=ogg
242
243# Output filename format - change this to reflect your inner desire to
244# organize things differently than everyone else :)
245# You have the following variables at your disposal:
246# OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, and TRACKNUM.
247# Make sure to single-quote this variable. abcde will automatically create
248# the directory portion of this filename.
249# NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
250# Since multiple-output was integrated we always append the file type
251# to the files. Remove it from your user defined string if you are getting
252# files like ".ogg.ogg".
253#OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
254
255# Like OUTPUTFORMAT but for Various Artists discs.
d6718558 256#VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
c9c2ca27 257
56672932 258# Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
259#ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
260#VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
261
c9c2ca27 262# Define how many encoders to run at once. This makes for huge speedups
263# on SMP systems. Defaults to 1. Equivalent to -j.
264#MAXPROCS=2
265
266# Support for systems with low disk space:
267# n: Default parallelization (read entire CD in while encoding)
268# y: No parallelization (rip, encode, rip, encode...)
269#LOWDISK=n
270
81bc6204 271# If set to y, enables batch mode normalization, which preserves relative
8fe929a7 272# volume differences between tracks of an album.
273#BATCHNORM=n
274
275# Enables nogap encoding when using the 'lame' encoder.
cb05cebc 276#NOGAP=y
81bc6204 277
c9c2ca27 278# Set the playlist file location format. Uses the same variables and format
279# as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
280# will be created for you and the playlist will reference files from that
281# subdirectory.
282#PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
283# If you want to prefix every filename in a playlist with an arbitrary
284# string (such as 'http://you/yourstuff/'), use this option
285#PLAYLISTDATAPREFIX=''
286
287#Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
288#VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
289#VAPLAYLISTDATAPREFIX=''
290
291#This will give the playlist CR-LF line-endings, if set to "y".
99d009fa 292#(some hardware players insist on CR-LF line-endings)
c9c2ca27 293#DOSPLAYLIST=n
294
295# Custom filename munging:
296# By default, abcde will do the following to CDDB data to get a useful
297# filename:
298# * Translate colons to a space and a dash for Windows compatibility
299# * Eat control characters, single quotes, and question marks
300# * Translate spaces and forward slashes to underscores
301# To change that, redefine the mungefilename function.
8fe929a7 302# mungefilename receives the CDDB data (artist, track, title, whatever)
c9c2ca27 303# as $1 and outputs it on stdout.
304#mungefilename ()
305#{
3279389d 306# echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
c9c2ca27 307#}
308
7acef70b 309# Custom genre munging:
310# By default we just transform uppercase to lowercase. Not much of a fancy
8fe929a7 311# function, with not much use, but one can disable it or just turn the first
7acef70b 312# Uppercase.
313#mungegenre ()
314#{
315# echo $CDGENRE | tr "[:upper:]" "[:lower:]"
316#}
317
318
c9c2ca27 319# Custom pre-read function
320# By default it does nothing.
8fe929a7 321# You can set some things to get abcde function in better ways:
c9c2ca27 322# * Close the CD tray using eject -t (if available in eject and supported by
323# your CD device.
324# * Set the CD speed. You can also use the built-in options, but you can also
325# set it here. In Debian, eject -x and cdset -x do the job.
99d009fa 326# KEEP IN MIND that executables included in pre_read must be in your $PATH or
327# you have to define them with full /path/to/binary
65f3ebb1 328# Uncomment and substitute the ":" with your commands.
c9c2ca27 329#pre_read ()
330#{
331#:
332#}
333
65f3ebb1 334# Custom post-read function
335# By default it does nothing.
8fe929a7 336# You can set some things to get abcde function in better ways:
65f3ebb1 337# * Store a copy of the CD TOC.
338# KEEP IN MIND that executables included in post_read must be in your $PATH or
339# you have to define them with full /path/to/binary
340# Uncomment and substitute the ":" with your commands.
341#post_read ()
342#{
343#:
344#}
345
3279389d 346# post_encode
347# By default it does nothing.
348# You can set some things to get abcde function in better ways:
349# * Move the resulting directory over the network
350# * Compare results with a previously made run, for tests
351# KEEP IN MIND that executables included in post_encode must be in your $PATH or
352# you have to define them with full /path/to/binary
353# Uncomment and substitute the ":" with your commands.
354#post_encode ()
355#{
356#:
357#}
358
c9c2ca27 359# If you'd like to have abcde eject the cdrom after all the tracks have been
360# read, uncomment the following line.
361#EJECTCD=y
362
363# To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
364# on the local machine (requires distmp3 to be installed on local machine and
365# distmp3host to be installed and running on all remote machines - see README)
366#REMOTEHOSTS=foo,bar,baz,quux,qiix
b7f1cc84 367
368# Set to obtain some information about actions happening in the background
37282563 369# Useful if you have a slow network or CDDB servers seem unresponsive.
b7f1cc84 370#EXTRAVERBOSE=n