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