Syntax changes required by eyeD3 versions 0.7.0 and greater.
[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
c4df517c 62# mpcenc - encoder for MPCENCODERSYNTAX
ff61f948 63# faac, neroAacEnc - for AACENCODER
147e24a5 64# opusenc - for OPUSENCODER
65# default is a valid option for oggenc, lame, flac, speexenc, mpcenc, faac and opus.
c9c2ca27 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.
c9c2ca27 69#MP3ENCODERSYNTAX=default
70#OGGENCODERSYNTAX=default
71#FLACENCODERSYNTAX=default
72#SPEEXENCODERSYNTAX=default
c4df517c 73#MPCENCODERSYNTAX=default
56672932 74#AACENCODERSYNTAX=default
147e24a5 75#OPUSENCODERSYNTAX=default
c9c2ca27 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',
6b005b85 82# 'icedax', 'cdda2wav', 'dagrab', 'cddafs' (Mac OS X only) and 'flac'.
c9c2ca27 83#CDROMREADERSYNTAX=cdparanoia
84
581a2153 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.
f00ed3e7 89#CUEREADERSYNTAX=default
90
581a2153 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
c9c2ca27 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
d0491de2 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
c9c2ca27 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
c1bbe6c3 122#TOOLAME=toolame
c9c2ca27 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
c4df517c 132#MPCENC=mpcenc
56672932 133#AACENC=faac
147e24a5 134#OPUSENC=opusenc
9f659ada 135
c9c2ca27 136#ID3=id3
4760e465 137#EYED3=eyeD3
c9c2ca27 138#CDPARANOIA=cdparanoia
6b005b85 139#CDDA2WAV=icedax
c9c2ca27 140#CDDAFS=cp
141#CDDISCID=cd-discid
142#CDDBTOOL=cddb-tool
143#EJECT=eject
144#MD5SUM=md5sum
145#DISTMP3=distmp3
146#VORBISCOMMENT=vorbiscomment
c008b56d 147#METAFLAC=metaflac
72d7162b 148#NORMALIZE=normalize-audio
c9c2ca27 149#CDSPEED=eject
6119aaa1 150#VORBISGAIN=vorbisgain
151#MKCUE=mkcue
9ff5088c 152#MKTOC=cdrdao
153#DIFF=diff
c9c2ca27 154
155# Options to call programs with:
156
157# If HTTPGET is modified, the HTTPGETOPTS options should also be defined
158# accordingly. If HTTPGET is changed, the default options will be set,
159# if HTTPGETOPTS is empty or not defined.
160#HTTPGET=wget
161# for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
e823b911 162# for wget: HTTPGETOPTS="-q -nv -O -"
c9c2ca27 163# for curl (MacOSX): HTTPGETOPTS="-f -s"
164#HTTPGETOPTS="-q -O -"
165
166# MP3:
167#LAMEOPTS=
c1bbe6c3 168#TOOLAMEOPTS=
c9c2ca27 169#GOGOOPTS=
170#BLADEENCOPTS=
171#L3ENCOPTS=
172#XINGMP3ENCOPTS=
173#MP3ENCOPTS=
174
175# Ogg:
176#VORBIZEOPTS=
177#OGGENCOPTS=
178
179# FLAC:
da01ddc3 180#FLACOPTS="-f"
c9c2ca27 181
182# Speex:
183#SPEEXENCOPTS=
184
99d009fa 185# MPP/MP+ (Musepack):
c4df517c
E
186# For the encoder options look at: mpcenc --longhelp. Set them like this:
187# MPCENCOPTS='--xtreme' if you wish to set more options then:
188# MPCENCOPTS='--xtreme --skip 20 --fade 10'
189#MPCENCOPTS=
99d009fa 190
56672932 191# M4A/AAC
ff61f948 192#For faac encoding try the following options (see also: faac --help):
193#AACENC=faac
194#AACENCOPTS='-q 250 -w -s'
195#OUTPUTTYPE="m4a"
196# For neroAacEnc encoding try the following options (see also neroAacEnc -help):
197#AACENC=neroAacEnc
198#AACENCOPTS='-q 0.65'
199#OUTPUTTYPE="m4a"
200#ATOMICPARSLEY='AtomicParsley'
56672932 201
147e24a5 202# OPUS
203# For the encoder options look at: opusenc -h.
204#OPUSENCOPTS='--bitrate 128'
205
c9c2ca27 206#ID3OPTS=
4760e465 207#EYED3OPTS="--set-encoding=utf16-LE"
c9c2ca27 208#CDPARANOIAOPTS=
209#CDDA2WAVOPTS=
210#CDDAFSOPTS="-f"
211#CDDBTOOLOPTS=
212#EJECTOPTS=
213#DISTMP3OPTS=
214#NORMALIZEOPTS=
215#CDSPEEDOPTS="-x"
216#CDSPEEDVALUE=""
6119aaa1 217#MKCUEOPTS=""
9ff5088c 218#MKTOCOPTS=""
219#DIFFOPTS=""
6119aaa1 220#VORBISCOMMENTOPTS="-R"
221#METAFLACOPTS="--no-utf8-convert"
c1bbe6c3 222#DIFFOPTS=""
c9c2ca27 223
224# Actions to take
225# Comma-separated list of one or more of the following:
f7c6d185 226# cddb,cue,read,normalize,encode,tag,move,playlist,clean,default
c9c2ca27 227# encode implies read
228# normalize implies read
229# tag implies cddb,read,encode
230# move implies cddb,read,encode,tag
231# playlist implies cddb
f7c6d185 232# An action can be added to the "default" action by specifying it along with
233# "default", without having to repeat the default ones:
234# ACTIONS=default,playlist
235# The default action list (referenced as "default") is defined in the following
236# comment:
c9c2ca27 237#ACTIONS=cddb,read,encode,tag,move,clean
238
c9c2ca27 239# CD device you want to read from
1b94d6b7 240# It can be defined as a singletrack flac file, but since it might change from
241# file to file it makes little sense to define it here.
c9c2ca27 242#CDROM=/dev/cdrom
c008b56d 243# If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
244# If we are using the ide-scsi emulation layer, we need to define a "g"
245#CDPARANOIACDROMBUS="d"
c9c2ca27 246
247# If you'd like to make a default location that overrides the current
248# directory for putting mp3's, uncomment this.
249#OUTPUTDIR=`pwd`
250
251# Or if you'd just like to put the temporary .wav files somewhere else
252# you can specify that here
253#WAVOUTPUTDIR=`pwd`
254
147e24a5 255# OUTPUTTYPE can be either "ogg", "mp3", "flac", "spx", "opus" or a combination
c9c2ca27 256# of them separated with ",": "ogg,mp3".
257#OUTPUTTYPE=ogg
258
259# Output filename format - change this to reflect your inner desire to
260# organize things differently than everyone else :)
261# You have the following variables at your disposal:
711c0743 262# OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, TRACKNUM and YEAR.
c9c2ca27 263# Make sure to single-quote this variable. abcde will automatically create
264# the directory portion of this filename.
265# NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
266# Since multiple-output was integrated we always append the file type
267# to the files. Remove it from your user defined string if you are getting
268# files like ".ogg.ogg".
269#OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
270
271# Like OUTPUTFORMAT but for Various Artists discs.
d6718558 272#VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
c9c2ca27 273
56672932 274# Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
275#ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
276#VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
277
c9c2ca27 278# Define how many encoders to run at once. This makes for huge speedups
279# on SMP systems. Defaults to 1. Equivalent to -j.
280#MAXPROCS=2
281
282# Support for systems with low disk space:
283# n: Default parallelization (read entire CD in while encoding)
284# y: No parallelization (rip, encode, rip, encode...)
285#LOWDISK=n
286
81bc6204 287# If set to y, enables batch mode normalization, which preserves relative
8fe929a7 288# volume differences between tracks of an album.
289#BATCHNORM=n
290
291# Enables nogap encoding when using the 'lame' encoder.
cb05cebc 292#NOGAP=y
81bc6204 293
c9c2ca27 294# Set the playlist file location format. Uses the same variables and format
295# as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
296# will be created for you and the playlist will reference files from that
297# subdirectory.
298#PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
299# If you want to prefix every filename in a playlist with an arbitrary
300# string (such as 'http://you/yourstuff/'), use this option
301#PLAYLISTDATAPREFIX=''
302
303#Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
304#VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
305#VAPLAYLISTDATAPREFIX=''
306
307#This will give the playlist CR-LF line-endings, if set to "y".
99d009fa 308#(some hardware players insist on CR-LF line-endings)
c9c2ca27 309#DOSPLAYLIST=n
310
311# Custom filename munging:
312# By default, abcde will do the following to CDDB data to get a useful
313# filename:
314# * Translate colons to a space and a dash for Windows compatibility
315# * Eat control characters, single quotes, and question marks
316# * Translate spaces and forward slashes to underscores
317# To change that, redefine the mungefilename function.
8fe929a7 318# mungefilename receives the CDDB data (artist, track, title, whatever)
c9c2ca27 319# as $1 and outputs it on stdout.
320#mungefilename ()
321#{
3279389d 322# echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
c9c2ca27 323#}
324
7acef70b 325# Custom genre munging:
326# By default we just transform uppercase to lowercase. Not much of a fancy
8fe929a7 327# function, with not much use, but one can disable it or just turn the first
7acef70b 328# Uppercase.
329#mungegenre ()
330#{
331# echo $CDGENRE | tr "[:upper:]" "[:lower:]"
332#}
333
334
c9c2ca27 335# Custom pre-read function
336# By default it does nothing.
8fe929a7 337# You can set some things to get abcde function in better ways:
c9c2ca27 338# * Close the CD tray using eject -t (if available in eject and supported by
339# your CD device.
340# * Set the CD speed. You can also use the built-in options, but you can also
341# set it here. In Debian, eject -x and cdset -x do the job.
99d009fa 342# KEEP IN MIND that executables included in pre_read must be in your $PATH or
343# you have to define them with full /path/to/binary
65f3ebb1 344# Uncomment and substitute the ":" with your commands.
c9c2ca27 345#pre_read ()
346#{
347#:
348#}
349
65f3ebb1 350# Custom post-read function
351# By default it does nothing.
8fe929a7 352# You can set some things to get abcde function in better ways:
65f3ebb1 353# * Store a copy of the CD TOC.
354# KEEP IN MIND that executables included in post_read must be in your $PATH or
355# you have to define them with full /path/to/binary
356# Uncomment and substitute the ":" with your commands.
357#post_read ()
358#{
359#:
360#}
361
3279389d 362# post_encode
363# By default it does nothing.
364# You can set some things to get abcde function in better ways:
365# * Move the resulting directory over the network
366# * Compare results with a previously made run, for tests
367# KEEP IN MIND that executables included in post_encode must be in your $PATH or
368# you have to define them with full /path/to/binary
369# Uncomment and substitute the ":" with your commands.
370#post_encode ()
371#{
372#:
373#}
374
c9c2ca27 375# If you'd like to have abcde eject the cdrom after all the tracks have been
376# read, uncomment the following line.
377#EJECTCD=y
378
379# To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
380# on the local machine (requires distmp3 to be installed on local machine and
381# distmp3host to be installed and running on all remote machines - see README)
382#REMOTEHOSTS=foo,bar,baz,quux,qiix
b7f1cc84 383
7172fbaf 384# Set to 1,2, etc. to obtain some information about actions happening in the background
37282563 385# Useful if you have a slow network or CDDB servers seem unresponsive.
7172fbaf 386#EXTRAVERBOSE=0