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