Updates to the man pages for libcdio (cd-paranoia)
[abcde.git] / abcde.conf
1 # System defaults for abcde version 2.6.1
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 # currently recognized options are 'cddb' and 'musicbrainz'
10 #CDDBMETHOD=cddb
11
12 # If you wish to use a different CDDB server, edit this line.
13 # If you just wanted to use a proxy server, just set your http_proxy
14 # environment variable - wget will use it correctly.
15 #CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
16
17 # The CDDB protocol level.
18 # Right now 5 is latin1 output and 6 is UTF8 encoding.
19 #CDDBPROTO=6
20
21 # The CDDB protocol requires hello information, including a valid username
22 # and hostname. If you feel paranoid about giving away such info, edit this
23 # line - the format is username@hostname.
24 #HELLOINFO="`whoami`@`hostname`"
25
26 # This controls the email address CDDB changes are submitted to.
27 #CDDBSUBMIT=freedb-submit@freedb.org
28
29 # The following options control whether or not fetched CDDB entries
30 # are cached locally in $CDDBLOCALDIR
31 #CDDBCOPYLOCAL="n"
32 #CDDBLOCALDIR="$HOME/.cddb"
33 #CDDBLOCALRECURSIVE="y"
34
35 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
36 # wish to submit your edited cddb file.
37 #NOSUBMIT=n
38
39 # If NOCDDBQUERY is set to y, then abcde will never even try to access
40 # the CDDB server; running abcde will automatically drop you into a
41 # blank cddb file to edit at your leisure.  This is the same as the
42 # -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
43 #NOCDDBQUERY=n
44
45 # Select here if you want to use the locally stored CDDB entries.
46 # This is useful if you do a lot of editing to those CDDB entries.
47 # Also, other tools like Grip store CDDB entries under $HOME/.cddb,
48 # so they can be reused when ripping CDs. (If this is set to "y" make
49 # sure that CDDBLOCALRECURSIVE is also set to "y".)
50 #CDDBUSELOCAL="n"
51
52 # List, separated with a comma, the fields we want the parsing function to
53 # output. Defaults to YEAR and GENRE, for a complete list of fields provided by
54 # CDDB.
55 # The fields are not case sensitive. Actually, "y,g" will work as fine as "Y,G"
56 # or "YEAR, GENRE"
57 #SHOWCDDBFIELDS=year,genre
58
59 # Specify the style of encoder to use here -
60 # oggenc, vorbize - for OGGENCODERSYNTAX
61 # lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
62 # flac - the only supported for FLACENCODERSYNTAX at the moment
63 # speexenc - the only encoder for SPEEXENCODERSYNTAX
64 # mpcenc - encoder for MPCENCODERSYNTAX
65 # wavpack - encoder for WVENCODERSYNTAX
66 # mac - for APENCODERSYNTAX
67 # faac, neroAacEnc, fdkaac - for AACENCODERSYNTAX
68 # opusenc - for OPUSENCODERSYNTAX
69 # default is a valid option for oggenc, lame, flac, speexenc, mpcenc, wavpack, faac and opus.
70 # Currently this affects the default location of the binary, the variable
71 # to pick encoder command-line options from, and where the options are
72 # given.
73 #MP3ENCODERSYNTAX=default
74 #OGGENCODERSYNTAX=default
75 #FLACENCODERSYNTAX=default
76 #SPEEXENCODERSYNTAX=default
77 #MPCENCODERSYNTAX=default
78 #WVENCODERSYNTAX=default
79 #APENCODERSYNTAX=default
80 #AACENCODERSYNTAX=default
81 #OPUSENCODERSYNTAX=default
82
83 # Specify the syntax of the normalize binary here - so far only 'normalize'
84 # is supported.
85 #NORMALIZERSYNTAX=default
86
87 # CD reader program to use - currently recognized options are 'cdparanoia',
88 # 'libcdio' (cd-paranoia),'icedax', 'cdda2wav', 'dagrab', 'pird',
89 # 'cddafs' (Mac OS X only) and 'flac'.
90 #CDROMREADERSYNTAX=cdparanoia
91
92 # CUE reader syntax for the CUE reader program to use.
93 # abcde supports 2 CUE modes: 'mkcue' and 'abcde.mkcue' so you can set the
94 # MKCUE variable accordingly. The 'abcde.mkcue' uses an internal
95 # implementation, without the need of an external program.
96 #CUEREADERSYNTAX=default
97
98 # Specify the program to convert a CUE sheet back to a CD disc ID for CDDB queries.
99 # Select between '/path/to/cue2discid' (provided as an example) or
100 # 'abcde.cue2discid', implemented internaly.
101 #CUE2DISCID=abcde.cue2discid
102
103 # Keep the wav files after encoding. Set it to "y" and remove "clean" from
104 # the list of default actions, since we purge the temp directory as default.
105 #KEEPWAVS=n
106
107 # Track padding: force abcde to pad tracks using 0, so every song uses a two
108 # digit entry. If set to "y", even a single song encoding outputs a file like
109 # 01.my_song.ext
110 #PADTRACKS=n
111
112 # Define if you want abcde to be non-interactive.
113 # Keep in mind that there is no way to deactivate it right now in the command
114 # line, so setting this option makes abcde to be always non-interactive.
115 #INTERACTIVE=n
116
117 # Specify 'nice'ness of the encoder, the CD reader and the distmp3 proc.
118 # This is a relative 'nice'ness (that is, if the parent process is at a
119 # nice level of 12, and the ENCNICE is set to 3, then the encoder will
120 # run with an absolute nice value of 15. Note also, that setting these
121 # to be empty will result in some default niceness increase (4 in tcsh
122 # and 10 using the bsdutils' nice).
123 #ENCNICE=10
124 #READNICE=10
125 #DISTMP3NICE=10
126
127 # Paths of programs to use
128
129 # Encoders:
130 #LAME=lame
131 #TOOLAME=toolame
132 #GOGO=gogo
133 #BLADEENC=bladeenc
134 #L3ENC=l3enc
135 #XINGMP3ENC=xingmp3enc
136 #MP3ENC=mp3enc
137 #VORBIZE=vorbize
138 #OGGENC=oggenc
139 #FLAC=flac
140 #SPEEXENC=speexenc
141 #MPCENC=mpcenc
142 #WVENC=wavpack
143 #APENC=mac
144 #FAAC=faac
145 #NEROAACENC=neroAacEnc
146 #FDKAAC=fdkaac
147 #OPUSENC=opusenc
148
149 # Taggers, rippers, replaygain etc:
150 #ID3=id3
151 #ID3V2=id3v2
152 #EYED3=eyeD3
153 #CDPARANOIA=cdparanoia
154 #CD_PARANOIA=cd-paranoia
155 #CDDA2WAV=icedax
156 #PIRD=pird
157 #CDDAFS=cp
158 #CDDISCID=cd-discid
159 #CDDBTOOL=cddb-tool
160 #EJECT=eject
161 #MD5SUM=md5sum
162 #DISTMP3=distmp3
163 #VORBISCOMMENT=vorbiscomment
164 #METAFLAC=metaflac
165 #NORMALIZE=normalize-audio
166 #CDSPEED=eject
167 #VORBISGAIN=vorbisgain
168 #MKCUE=mkcue
169 #MKTOC=cdrdao
170 #DIFF=diff
171 #WVGAIN=wvgain
172 #APETAG=apetag
173 #GLYRC=glyrc
174
175 # Options to call programs with:
176
177 # If HTTPGET is modified, the HTTPGETOPTS options should also be defined
178 # accordingly. If HTTPGET is changed, the default options will be set,
179 # if HTTPGETOPTS is empty or not defined.
180 #HTTPGET=wget
181 # for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
182 # for wget: HTTPGETOPTS="-q -nv -O -"
183 # for curl (MacOSX): HTTPGETOPTS="-f -s"
184 #HTTPGETOPTS="-q -O -"
185
186 # MP3:
187 # For the best LAME encoder options have a look at:
188 # <http://wiki.hydrogenaudio.org/index.php?title=LAME#Recommended_encoder_settings>
189 # A good option is '-V 0' which gives Variable Bitrate Rate (VBR) recording
190 # with a target bitrate of ~245 Kbps and a bitrate range of 220...260 Kbps.
191 #LAMEOPTS=
192 #TOOLAMEOPTS=
193 #GOGOOPTS=
194 # Bladeenc still works with abcde in 2015, and the last release of bladeenc
195 # was in 2001! Settings that will produce a great encode are: '-br 192' 
196 #BLADEENCOPTS=
197 # L3enc still works with abcde in 2015, pretty amazing when you realise 
198 # that the last release of l3enc was in 1997! Settings that will produce 
199 # a great encode are: '-br 256000 -hq -crc'
200 #L3ENCOPTS=
201 #XINGMP3ENCOPTS=
202 # And mp3enc also still works with abcde in 2015 with the last release
203 # of mp3enc in 1998! Settings that will produce a great encode, albeit
204 # a slow one, are: '-v -br 256000 -qual 9 -no-is -bw 16500'
205 #MP3ENCOPTS=
206
207 # Ogg:
208 #VORBIZEOPTS=
209 #OGGENCOPTS=
210
211 # FLAC:
212 # The flac option is a workaround for an error where flac fails
213 # to encode with error 'floating point exception'. This is flac 
214 # error in get_console_width(), corrected in flac 1.3.1
215 #FLACOPTS="--silent"
216
217 # Speex:
218 #SPEEXENCOPTS=
219
220 # MPP/MP+ (Musepack):
221 # For the encoder options look at 'mpcenc --longhelp', consider
222 # setting '--extreme' for a good quality encode.
223 #MPCENCOPTS=
224
225 # WavPack:
226 # Look at 'wavpack --help' for detailed options, consider using '-hx3' 
227 # for a good quality encode
228 #WVENCOPTS=
229 # For Wavpack replay gain we set both the default of 'track gain' 
230 # as well as this option for 'album gain'. Better media players
231 # such as vlc can select either or neither.    
232 #WVGAINOPTS='-a'
233
234 # Monkey's Audio (ape)
235 # Without this set mac chokes unfortunately. Choices
236 # are from 1000 to 5000.
237 #APENCOPTS='-c4000'
238
239 # M4A/AAC
240 # Note that the old AACENCOPTS has been rendered obsolete by
241 # the following options, new to abcde 2.6.1:
242 #  1. faac: see 'faac --long-help' and consider
243 #     using '-q 250' for a good quality encode.
244 #FAACENCOPTS=
245 #  2. neroAacEnc: see 'neroAacEnc -help' and
246 #     consider using '-q 0.65' for a good quality encode.
247 #NEROAACENCOPTS=
248 #  3. fdkaac: see 'fdkaac --help' and consider using 
249 #     '--profile 2 --bitrate-mode 5 --afterburner 1'
250 #     for a good quality encode. 
251 #FDKAACENCOPTS='192k'
252
253 # OPUS
254 # For the encoder options look at: 'opusenc -h'
255 #OPUSENCOPTS=
256
257 # mp3 tagging:
258 # There are three ways to tag MP3 files:
259 #   1. id3v1 (with id3)
260 #   2. id3v2.3 (with id3v2)
261 #   3. id3v2.4 (with eyeD3) This is the default
262 # Use ID3TAGV to select one of the older formats:
263 #ID3TAGV=id3v2.4
264 #ID3OPTS=
265 #ID3V2OPTS=
266 #EYED3OPTS="--set-encoding=utf16-LE"
267
268 # Other options:
269 # The variable CDPARANOIOPTS is also used by GNU's cd-paranoia,
270 # so use this when setting CDROMREADERSYNTX=libcdio.
271 #CDPARANOIAOPTS=
272 #CDDA2WAVOPTS=
273 #PIRDOPTS="-p"
274 #CDDAFSOPTS="-f"
275 #CDDBTOOLOPTS=
276 #EJECTOPTS=
277 #DISTMP3OPTS=
278 #NORMALIZEOPTS=
279 #CDSPEEDOPTS="-x"
280 #CDSPEEDVALUE=""
281 #MKCUEOPTS=""
282 #MKTOCOPTS=""
283 #DIFFOPTS=""
284 #VORBISCOMMENTOPTS="-R"
285 #METAFLACOPTS="--no-utf8-convert"
286
287 # Actions to take
288 # Comma-separated list of one or more of the following:
289 #  cddb,cue,read,normalize,encode,tag,move,replaygain,playlist,getalbumart,clean,default
290 #   encode implies read
291 #   normalize implies read
292 #   tag implies cddb,read,encode
293 #   move implies cddb,read,encode,tag
294 #   replaygain implies cddb,read,encode,tag,move
295 #   playlist implies cddb
296 # An action can be added to the "default" action by specifying it along with
297 # "default", without having to repeat the default ones:
298 #  ACTIONS=default,playlist
299 # The default action list (referenced as "default") is defined in the following
300 # comment:
301 #ACTIONS=cddb,read,encode,tag,move,clean
302
303 # CD device you want to read from
304 # It can be defined as a singletrack flac file, but since it might change from
305 # file to file it makes little sense to define it here.
306 #CDROM=/dev/cdrom
307 # If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
308 # If we are using the ide-scsi emulation layer, we need to define a "g"
309 #CDPARANOIACDROMBUS="d"
310
311 # If you'd like to make a default location that overrides the current
312 # directory for putting mp3's, uncomment this.
313 #OUTPUTDIR=`pwd`
314
315 # Or if you'd just like to put the temporary .wav files somewhere else
316 # you can specify that here
317 #WAVOUTPUTDIR=`pwd`
318
319 # OUTPUTTYPE can be any of a number of formats, either a single format
320 # (e.g. "ogg") or a combination of them separated with ","
321 # (e.g. "flac,mp3"). Currently recognised and supported are:
322 # "flac", "m4a", "mp3, "mpc", "ogg", "opus", "spx", "vorbis", "wav", "wv", "ape"
323 #OUTPUTTYPE=ogg
324
325 # Output filename format - change this to reflect your inner desire to
326 # organize things differently than everyone else :)
327 # You have the following variables at your disposal:
328 # OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, TRACKNUM and YEAR.
329 # Make sure to single-quote this variable. abcde will automatically create
330 # the directory portion of this filename.
331 # NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
332 # Since multiple-output was integrated we always append the file type
333 # to the files. Remove it from your user defined string if you are getting
334 # files like ".ogg.ogg".
335 #OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
336
337 # Like OUTPUTFORMAT but for Various Artists discs.
338 #VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
339
340 # Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
341 #ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
342 #VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
343
344 # Define how many encoders to run at once. This makes for huge speedups
345 # on SMP systems. Defaults to 1. Equivalent to -j.
346 #MAXPROCS=2
347
348 # Support for systems with low disk space:
349 # n:    Default parallelization (read entire CD in while encoding)
350 # y:    No parallelization (rip, encode, rip, encode...)
351 #LOWDISK=n
352
353 # If set to y, enables batch mode normalization, which preserves relative
354 # volume differences between tracks of an album.
355 #BATCHNORM=n
356
357 # Enables nogap encoding when using the 'lame' encoder.
358 #NOGAP=y
359
360 # Set the playlist file location format. Uses the same variables and format
361 # as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
362 # will be created for you and the playlist will reference files from that
363 # subdirectory.
364 #PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
365 # If you want to prefix every filename in a playlist with an arbitrary
366 # string (such as 'http://you/yourstuff/'), use this option
367 #PLAYLISTDATAPREFIX=''
368
369 #Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
370 #VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
371 #VAPLAYLISTDATAPREFIX=''
372
373 #This will give the playlist CR-LF line-endings, if set to "y".
374 #(some hardware players insist on CR-LF line-endings)
375 #DOSPLAYLIST=n
376
377 # album art download options (see glyrc's help for details with more detailed 
378 # examples here: https://github.com/sahib/glyr/wiki/Commandline-arguments).
379 # These options: '--from <provider>' and '--lang <langcode>' might also be useful
380 #GLYRCOPTS="--formats jpg;jpeg"
381 #ALBUMARTFILE="cover.jpg"
382
383 # Custom filename munging:
384 # By default, abcde will do the following to CDDB data to get a useful
385 # filename:
386 # * Translate colons to a space and a dash for Windows compatibility
387 # * Eat control characters, single quotes, and question marks
388 # * Translate spaces and forward slashes to underscores
389 # To change that, redefine the mungefilename function.
390 # mungefilename receives the CDDB data (artist, track, title, whatever)
391 # as $1 and outputs it on stdout.
392 #mungefilename ()
393 #{
394 #       echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
395 #}
396
397 # Custom genre munging:
398 # By default we just transform uppercase to lowercase. Not much of a fancy
399 # function, with not much use, but one can disable it or just turn the first
400 # Uppercase.
401 #mungegenre ()
402 #{
403 #       echo $CDGENRE | tr "[:upper:]" "[:lower:]"
404 #}
405
406
407 # Custom pre-read function
408 # By default it does nothing.
409 # You can set some things to get abcde function in better ways:
410 # * Close the CD tray using eject -t (if available in eject and supported by
411 #   your CD device.
412 # * Set the CD speed. You can also use the built-in options, but you can also
413 #   set it here. In Debian, eject -x and cdset -x do the job.
414 # KEEP IN MIND that executables included in pre_read must be in your $PATH or
415 # you have to define them with full /path/to/binary
416 # Uncomment and substitute the ":" with your commands.
417 #pre_read ()
418 #{
419 #:
420 #}
421
422 # Custom post-read function
423 # By default it does nothing.
424 # You can set some things to get abcde function in better ways:
425 # * Store a copy of the CD TOC.
426 # KEEP IN MIND that executables included in post_read must be in your $PATH or
427 # you have to define them with full /path/to/binary
428 # Uncomment and substitute the ":" with your commands.
429 #post_read ()
430 #{
431 #:
432 #}
433
434 # post_encode
435 # By default it does nothing.
436 # You can set some things to get abcde function in better ways:
437 # * Move the resulting directory over the network
438 # * Compare results with a previously made run, for tests
439 # KEEP IN MIND that executables included in post_encode must be in your $PATH or
440 # you have to define them with full /path/to/binary
441 # Uncomment and substitute the ":" with your commands.
442 #post_encode ()
443 #{
444 #:
445 #}
446
447 # If you'd like to have abcde eject the cdrom after all the tracks have been
448 # read, uncomment the following line.
449 #EJECTCD=y
450
451 # To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
452 # on the local machine (requires distmp3 to be installed on local machine and
453 # distmp3host to be installed and running on all remote machines - see README)
454 #REMOTEHOSTS=foo,bar,baz,quux,qiix
455
456 # Set to 1,2, etc. to obtain some information about actions happening in the background
457 # Useful if you have a slow network or CDDB servers seem unresponsive.
458 #EXTRAVERBOSE=0