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