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