r168@frost: data | 2005-09-19 10:27:33 +0300
[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
9ff5088c 43# List, separated with a coma, the fields we want the parsing function to
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"
48#SHOWPARSEDFIELDS=year,genre
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',
71# 'cdda2wav', 'dagrab' and 'cddafs' (Mac OS X only).
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
104#GOGO=gogo
105#BLADEENC=bladeenc
106#L3ENC=l3enc
107#XINGMP3ENC=xingmp3enc
108#MP3ENC=mp3enc
109#VORBIZE=vorbize
110#OGGENC=oggenc
111#FLAC=flac
112#SPEEXENC=speexenc
9f659ada 113#MPPENC=mppenc
114
c9c2ca27 115#ID3=id3
116#ID3V2=id3v2
117#CDPARANOIA=cdparanoia
118#CDDA2WAV=cdda2wav
119#CDDAFS=cp
120#CDDISCID=cd-discid
121#CDDBTOOL=cddb-tool
122#EJECT=eject
123#MD5SUM=md5sum
124#DISTMP3=distmp3
125#VORBISCOMMENT=vorbiscomment
c008b56d 126#METAFLAC=metaflac
72d7162b 127#NORMALIZE=normalize-audio
c9c2ca27 128#CDSPEED=eject
6119aaa1 129#VORBISGAIN=vorbisgain
130#MKCUE=mkcue
9ff5088c 131#MKTOC=cdrdao
132#DIFF=diff
c9c2ca27 133
134# Options to call programs with:
135
136# If HTTPGET is modified, the HTTPGETOPTS options should also be defined
137# accordingly. If HTTPGET is changed, the default options will be set,
138# if HTTPGETOPTS is empty or not defined.
139#HTTPGET=wget
140# for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
141# for wget: HTTPGETOPTS="-q -O -"
142# for curl (MacOSX): HTTPGETOPTS="-f -s"
143#HTTPGETOPTS="-q -O -"
144
145# MP3:
146#LAMEOPTS=
147#GOGOOPTS=
148#BLADEENCOPTS=
149#L3ENCOPTS=
150#XINGMP3ENCOPTS=
151#MP3ENCOPTS=
152
153# Ogg:
154#VORBIZEOPTS=
155#OGGENCOPTS=
156
157# FLAC:
da01ddc3 158#FLACOPTS="-f"
c9c2ca27 159
160# Speex:
161#SPEEXENCOPTS=
162
99d009fa 163# MPP/MP+ (Musepack):
12c5d978 164# For the encoder options take a look at the manpage. Set them like this:
165# MPPENCOPTS='--xtreme' if you wish to set more options then:
166# MPPENCOPTS='--xtreme --skip 20 --fade 10'
99d009fa 167#MPPENCOPTS=
168
c9c2ca27 169#ID3OPTS=
170#ID3V2OPTS=
171#CDPARANOIAOPTS=
172#CDDA2WAVOPTS=
173#CDDAFSOPTS="-f"
174#CDDBTOOLOPTS=
175#EJECTOPTS=
176#DISTMP3OPTS=
177#NORMALIZEOPTS=
178#CDSPEEDOPTS="-x"
179#CDSPEEDVALUE=""
6119aaa1 180#MKCUEOPTS=""
9ff5088c 181#MKTOCOPTS=""
182#DIFFOPTS=""
6119aaa1 183#VORBISCOMMENTOPTS="-R"
184#METAFLACOPTS="--no-utf8-convert"
c9c2ca27 185
186# Actions to take
187# Comma-separated list of one or more of the following:
188# cddb,read,normalize,encode,tag,move,playlist,clean
189# encode implies read
190# normalize implies read
191# tag implies cddb,read,encode
192# move implies cddb,read,encode,tag
193# playlist implies cddb
194# The default action list is defined in the following comment.
195#ACTIONS=cddb,read,encode,tag,move,clean
196
c9c2ca27 197# CD device you want to read from
198#CDROM=/dev/cdrom
c008b56d 199# If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
200# If we are using the ide-scsi emulation layer, we need to define a "g"
201#CDPARANOIACDROMBUS="d"
c9c2ca27 202
203# If you'd like to make a default location that overrides the current
204# directory for putting mp3's, uncomment this.
205#OUTPUTDIR=`pwd`
206
207# Or if you'd just like to put the temporary .wav files somewhere else
208# you can specify that here
209#WAVOUTPUTDIR=`pwd`
210
211# OUTPUTTYPE can be either "ogg", "mp3", "flac" or "spx", or a combination
212# of them separated with ",": "ogg,mp3".
213#OUTPUTTYPE=ogg
214
215# Output filename format - change this to reflect your inner desire to
216# organize things differently than everyone else :)
217# You have the following variables at your disposal:
218# OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, and TRACKNUM.
219# Make sure to single-quote this variable. abcde will automatically create
220# the directory portion of this filename.
221# NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
222# Since multiple-output was integrated we always append the file type
223# to the files. Remove it from your user defined string if you are getting
224# files like ".ogg.ogg".
225#OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
226
227# Like OUTPUTFORMAT but for Various Artists discs.
d6718558 228#VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
c9c2ca27 229
230# Define how many encoders to run at once. This makes for huge speedups
231# on SMP systems. Defaults to 1. Equivalent to -j.
232#MAXPROCS=2
233
234# Support for systems with low disk space:
235# n: Default parallelization (read entire CD in while encoding)
236# y: No parallelization (rip, encode, rip, encode...)
237#LOWDISK=n
238
81bc6204 239# If set to y, enables batch mode normalization, which preserves relative
240# volume differences between tracks of an album. Also enables nogap encoding
241# when using the 'lame' encoder.
242#BATCH=n
243
c9c2ca27 244# Set the playlist file location format. Uses the same variables and format
245# as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
246# will be created for you and the playlist will reference files from that
247# subdirectory.
248#PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
249# If you want to prefix every filename in a playlist with an arbitrary
250# string (such as 'http://you/yourstuff/'), use this option
251#PLAYLISTDATAPREFIX=''
252
253#Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
254#VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
255#VAPLAYLISTDATAPREFIX=''
256
257#This will give the playlist CR-LF line-endings, if set to "y".
99d009fa 258#(some hardware players insist on CR-LF line-endings)
c9c2ca27 259#DOSPLAYLIST=n
260
261# Custom filename munging:
262# By default, abcde will do the following to CDDB data to get a useful
263# filename:
264# * Translate colons to a space and a dash for Windows compatibility
265# * Eat control characters, single quotes, and question marks
266# * Translate spaces and forward slashes to underscores
7acef70b 267# * Translate stars into pluses.
c9c2ca27 268# To change that, redefine the mungefilename function.
269# mungefilename recieves the CDDB data (artist, track, title, whatever)
270# as $1 and outputs it on stdout.
271#mungefilename ()
272#{
40c61684 273# echo "$@" | sed s,:,\ -,g | tr \ /\* __+ | tr -d \'\"\?\[:cntrl:\]
c9c2ca27 274#}
275
7acef70b 276# Custom genre munging:
277# By default we just transform uppercase to lowercase. Not much of a fancy
278# function, with not much use, but one can disable it ot just turn the first
279# Uppercase.
280#mungegenre ()
281#{
282# echo $CDGENRE | tr "[:upper:]" "[:lower:]"
283#}
284
285
c9c2ca27 286# Custom pre-read function
287# By default it does nothing.
288# You can set some things to get abcde funtion in better ways:
289# * Close the CD tray using eject -t (if available in eject and supported by
290# your CD device.
291# * Set the CD speed. You can also use the built-in options, but you can also
292# set it here. In Debian, eject -x and cdset -x do the job.
99d009fa 293# KEEP IN MIND that executables included in pre_read must be in your $PATH or
294# you have to define them with full /path/to/binary
65f3ebb1 295# Uncomment and substitute the ":" with your commands.
c9c2ca27 296#pre_read ()
297#{
298#:
299#}
300
65f3ebb1 301# Custom post-read function
302# By default it does nothing.
303# You can set some things to get abcde funtion in better ways:
304# * Store a copy of the CD TOC.
305# KEEP IN MIND that executables included in post_read must be in your $PATH or
306# you have to define them with full /path/to/binary
307# Uncomment and substitute the ":" with your commands.
308#post_read ()
309#{
310#:
311#}
312
c9c2ca27 313# If you'd like to have abcde eject the cdrom after all the tracks have been
314# read, uncomment the following line.
315#EJECTCD=y
316
317# To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
318# on the local machine (requires distmp3 to be installed on local machine and
319# distmp3host to be installed and running on all remote machines - see README)
320#REMOTEHOSTS=foo,bar,baz,quux,qiix
b7f1cc84 321
322# Set to obtain some information about actions happening in the background
323# Usefull if you have a slow network or CDDB servers seem irresponsive.
324#EXTRAVERBOSE=n