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