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