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