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