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