ffb23ee2370be07e2af509fd4c9e1339b8f75374
[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 #ID3=id3
85 #ID3V2=id3v2
86 #CDPARANOIA=cdparanoia
87 #CDDA2WAV=cdda2wav
88 #CDDAFS=cp
89 #CDDISCID=cd-discid
90 #CDDBTOOL=cddb-tool
91 #EJECT=eject
92 #MD5SUM=md5sum
93 #DISTMP3=distmp3
94 #VORBISCOMMENT=vorbiscomment
95 #NORMALIZE=normalize
96 #CDSPEED=eject
97
98 # Options to call programs with:
99
100 # If HTTPGET is modified, the HTTPGETOPTS options should also be defined 
101 # accordingly. If HTTPGET is changed, the default options will be set,
102 # if HTTPGETOPTS is empty or not defined.
103 #HTTPGET=wget
104 # for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
105 # for wget: HTTPGETOPTS="-q -O -"
106 # for curl (MacOSX): HTTPGETOPTS="-f -s"
107 #HTTPGETOPTS="-q -O -"
108
109 # MP3:
110 #LAMEOPTS=
111 #GOGOOPTS=
112 #BLADEENCOPTS=
113 #L3ENCOPTS=
114 #XINGMP3ENCOPTS=
115 #MP3ENCOPTS=
116
117 # Ogg:
118 #VORBIZEOPTS=
119 #OGGENCOPTS=
120
121 # FLAC:
122 #FLACOPTS=
123
124 # Speex:
125 #SPEEXENCOPTS=
126
127 # MPP/MP+ (Musepack):
128 #MPPENCOPTS=
129
130 #ID3OPTS=
131 #ID3V2OPTS=
132 #CDPARANOIAOPTS=
133 #CDDA2WAVOPTS=
134 #CDDAFSOPTS="-f"
135 #CDDBTOOLOPTS=
136 #EJECTOPTS=
137 #DISTMP3OPTS=
138 #NORMALIZEOPTS=
139 #CDSPEEDOPTS="-x"
140 #CDSPEEDVALUE=""
141
142 # Actions to take
143 # Comma-separated list of one or more of the following:
144 #  cddb,read,normalize,encode,tag,move,playlist,clean
145 #   encode implies read
146 #   normalize implies read
147 #   tag implies cddb,read,encode
148 #   move implies cddb,read,encode,tag
149 #   playlist implies cddb
150 # The default action list is defined in the following comment.
151 #ACTIONS=cddb,read,encode,tag,move,clean
152
153 # CDDB options
154 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
155 # wish to submit your edited cddb file.
156 #NOSUBMIT=n
157 # If NOCDDBQUERY is set to y, then abcde will never even try to access
158 # the CDDB server; running abcde will automatically drop you into a
159 # blank cddb file to edit at your leisure.  This is the same as the
160 # -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
161 #NOCDDBQUERY=n
162
163 # CD device you want to read from
164 #CDROM=/dev/cdrom
165
166 # If you'd like to make a default location that overrides the current
167 # directory for putting mp3's, uncomment this.
168 #OUTPUTDIR=`pwd`
169
170 # Or if you'd just like to put the temporary .wav files somewhere else
171 # you can specify that here
172 #WAVOUTPUTDIR=`pwd`
173
174 # OUTPUTTYPE can be either "ogg", "mp3", "flac" or "spx", or a combination
175 # of them separated with ",": "ogg,mp3".
176 #OUTPUTTYPE=ogg
177
178 # Output filename format - change this to reflect your inner desire to
179 # organize things differently than everyone else :)
180 # You have the following variables at your disposal:
181 # OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, and TRACKNUM.
182 # Make sure to single-quote this variable. abcde will automatically create
183 # the directory portion of this filename.
184 # NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
185 # Since multiple-output was integrated we always append the file type
186 # to the files. Remove it from your user defined string if you are getting
187 # files like ".ogg.ogg".
188 #OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
189
190 # Like OUTPUTFORMAT but for Various Artists discs.
191 #VAOUTPUTFORMAT='${ARTISTFILE}/${TRACKFILE}'
192
193 # Define how many encoders to run at once. This makes for huge speedups
194 # on SMP systems. Defaults to 1. Equivalent to -j.
195 #MAXPROCS=2
196
197 # Support for systems with low disk space:
198 # n:    Default parallelization (read entire CD in while encoding)
199 # y:    No parallelization (rip, encode, rip, encode...)
200 #LOWDISK=n
201
202 # Set the playlist file location format. Uses the same variables and format
203 # as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
204 # will be created for you and the playlist will reference files from that
205 # subdirectory.
206 #PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
207 # If you want to prefix every filename in a playlist with an arbitrary
208 # string (such as 'http://you/yourstuff/'), use this option
209 #PLAYLISTDATAPREFIX=''
210
211 #Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
212 #VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
213 #VAPLAYLISTDATAPREFIX=''
214
215 #This will give the playlist CR-LF line-endings, if set to "y".
216 #(some hardware players insist on CR-LF line-endings)
217 #DOSPLAYLIST=n
218
219 # Custom filename munging:
220 # By default, abcde will do the following to CDDB data to get a useful
221 # filename:
222 # * Translate colons to a space and a dash for Windows compatibility
223 # * Eat control characters, single quotes, and question marks
224 # * Translate spaces and forward slashes to underscores
225 # To change that, redefine the mungefilename function.
226 # mungefilename recieves the CDDB data (artist, track, title, whatever)
227 # as $1 and outputs it on stdout.
228 #mungefilename ()
229 #{
230 #       echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
231 #}
232
233 # Custom pre-read function
234 # By default it does nothing.
235 # You can set some things to get abcde funtion in better ways:
236 # * Close the CD tray using eject -t (if available in eject and supported by 
237 #   your CD device.
238 # * Set the CD speed. You can also use the built-in options, but you can also 
239 #   set it here. In Debian, eject -x and cdset -x do the job.
240 # KEEP IN MIND that executables included in pre_read must be in your $PATH or
241 # you have to define them with full /path/to/binary
242 #pre_read ()
243 #{
244 #:
245 #}
246
247 # If you'd like to have abcde eject the cdrom after all the tracks have been
248 # read, uncomment the following line.
249 #EJECTCD=y
250
251 # To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
252 # on the local machine (requires distmp3 to be installed on local machine and
253 # distmp3host to be installed and running on all remote machines - see README)
254 #REMOTEHOSTS=foo,bar,baz,quux,qiix