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