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