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