67cb58298e4bbc93e2492c7ff0966fdc9c05eefc
[abcde.git] / abcde.1
1 .TH abcde 1
2 .SH NAME
3 abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, AAC, 
4 WavPack, Monkey's Audio (ape), MPP/MP+(Musepack), True Audio (tta) and/or MP2 format.
5 .SH SYNOPSIS
6 .B abcde
7 .I [options] [tracks]
8 .SH DESCRIPTION
9 Ordinarily, the process of grabbing the data off a CD and encoding it, then
10 tagging or commenting it, is very involved.
11 .BR abcde
12 is designed to automate this. It will take an entire CD and convert it into
13 a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III (MP3), Free Lossless
14 Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack), M4A (AAC) wv (WavPack), 
15 Monkey's Audio (ape), Opus, True Audio (tta) or MPEG Audio Layer II (MP2) format(s).
16 With one command, it will:
17 .TP
18 .B *
19 Do a CDDB or Musicbrainz query over the Internet to look up your CD or
20 use a locally stored CDDB entry, or read CD-TEXT from your CD as a
21 fallback for track information
22 .TP
23 .B *
24 Download the album art appropriate for your music tracks with many
25 user configurable options for download and post download alterations
26 .TP
27 .B *
28 Grab an audio track (or all the audio CD tracks) from your CD
29 .TP
30 .B *
31 Normalize the volume of the individual file (or the album as a single unit)
32 .TP
33 .B *
34 Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A, wv (WavPack), 
35 Monkey's Audio (ape), Opus format(s) True Audio (tta) and/or MP2, all in one CD read
36 .TP
37 .B *
38 Comment or ID3/ID3v2 tag
39 .TP
40 .B *
41 Give an intelligible filename
42 .TP
43 .B *
44 Calculate replaygain values for the individual file (or the album as a single unit)
45 .TP
46 .B *
47 Delete the intermediate WAV file (or save it for later use)
48 .TP
49 .B *
50 Repeat until finished
51 .P
52 Alternatively,
53 .B abcde
54 can also grab a CD and turn it into a single FLAC file with an embedded
55 cuesheet which can be user later on as a source for other formats, and will be
56 treated as if it was the original CD. In a way,
57 .B abcde
58 can take a compressed backup of your CD collection.
59 .SH OPTIONS
60 .TP
61 .B \-1
62 Encode the whole CD in a single file. The resulting file uses the CD title
63 for tagging. If the resulting format is a flac file with an embedded cuesheet,
64 the file can be used as a source for creating other formats. Use "\-1 \-o
65 flac \-a default,cue" for obtaining such a file.
66 .TP
67 .B \-a [actions]
68 Comma-delimited list of actions to perform. Can be one or more of: cddb, cue,
69 read, getalbumart, normalize, encode, tag, move, replaygain, playlist, clean.
70 Normalize and encode imply read. Tag implies cddb, read, encode. Move implies
71 cddb, read, encode, tag. Replaygain implies cddb, read, encode, tag and move.
72 Playlist implies cddb. The default is to do all actions except cue, normalize,
73 replaygain, getalbumart and playlist.
74 .TP
75 .B \-b
76 Enable batch mode normalization. See the BATCHNORM configuration variable.
77 .TP
78 .B \-c [filename]
79 Specifies an additional configuration file to parse. Configuration options
80 in this file override those in \fI/etc/abcde.conf\fR or \fI$HOME/.abcde.conf\fR.
81 .TP
82 .B \-C [discid]
83 Allows you to resume a session for
84 .I discid
85 when you no longer have the CD available (\fBabcde\fR will automatically resume if
86 you still have the CD in the drive). You must have already finished at
87 least the "read" action during the previous session.
88 .TP
89 .B \-d [devicename | filename]
90 CD\-ROM block device that contains audio tracks to be read. Alternatively, a
91 single-track flac file with embedded cuesheet.
92 .TP
93 .B \-D
94 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
95 2>logfile')
96 .TP
97 .B \-e
98 Erase information about encoded tracks from the internal status file, to enable
99 other encodings if the wav files have been kept.
100 .TP
101 .B \-f
102 Force the removal of the temporary ABCDETEMPDIR directory, even when we have
103 not finished. For example, one can read and encode several formats, including
104 \'.ogg\', and later on execute a \'move\' action with only one of the given
105 formats. On a normal situation it would erase the rest of those encoded
106 formats. In this case, \fBabcde\fR will refuse to execute such command, except if \-f
107 is used.
108 .TP
109 .B \-g
110 Enable lame's \-\-nogap option.  See the NOGAP variable. WARNING: lame's
111 \-\-nogap disables the Xing mp3 tag.  This tag is required for mp3 players to
112 correctly display track lengths when playing variable-bit-rate mp3 files.
113 .TP
114 .B \-G
115 Download album art using the getalbumart function. This is best done with
116 CDDBMETHOD set to musicbrainz and requires the installation of glyrc.
117 ImageMagick is an optional but highly recommended package. Further details
118 of getalbumart can be found in the abcde FAQ document packaged with abcde.
119 .TP
120 .B \-h
121 Get help information.
122 .TP
123 .B \-j [number]
124 Start [number] encoder processes at once. Useful for SMP systems. Overrides
125 the MAXPROCS configuration variable. Set it to "0" when using \fBdistmp3\fR to avoid
126 local encoding processes.
127 .TP
128 .B \-k
129 Keep the wav files after encoding.
130 .TP
131 .B \-l
132 Use the low-diskspace algorithm. See the LOWDISK configuration variable.
133 .TP
134 .B \-L
135 Use a local CDDB repository. See CDDBLOCALDIR variable.
136 .TP
137 .B \-m
138 Create DOS-style playlists, modifying the resulting one by adding CRLF line
139 endings. Some hardware players insist on having those to work.
140 .TP
141 .B \-n
142 Do not query CDDB database. Create and use a template. Edit the template to
143 provide song names, artist(s), ...
144 .TP
145 .B \-N
146 Non interactive mode. Do not ask anything from the user. Just go ahead.
147 .TP
148 .B \-o [filetype][:filetypeoptions]
149 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc", "m4a", 
150 "wav", "wv", "ape", "opus" or "mka".  Specify a comma-delimited list of output types
151 to obtain all specified types.  See the OUTPUTTYPE configuration variable. One can
152 pass options to the encoder for a specific filetype on the command line separating
153 them with a colon. The options must be escaped with double-quotes.
154 .TP
155 .B \-p
156 Pads track numbers with 0\'s.
157 .TP
158 .B \-P
159 Use Unix PIPES to read and encode in one step (USEPIPES). This disables multiple
160 encodings, since the WAV audio file is never stored in the disc. For more detail
161 on this option see the FAQ document in the source tarball.
162 .TP
163 .B \-r [hosts...]
164 Remote encode on this comma-delimited list of machines using \fBdistmp3\fR. See
165 the REMOTEHOSTS configuration variable.
166 .TP
167 .B \-s [fields...]
168 List, separated by commas, the fields to be shown in the CDDB parsed entries.
169 Right now it only uses "year" and "genre".
170 .TP
171 .B \-S [speed]
172 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
173 and both the program and device must support the capability.
174 .TP
175 .B \-t [number]
176 Start the numbering of the tracks at a given number. It only affects the
177 filenames and the playlist. Internal (tag) numbering remains the same.
178 .TP
179 .B \-T [number]
180 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
181 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
182 .TP
183 .B \-U
184 Set CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
185 information, and we tag and add comments with Latin1 encoding.
186 .TP
187 .B \-v
188 Show the version and exit
189 .TP
190 .B \-V
191 Be more verbose. On slow networks the CDDB requests might give the
192 sensation nothing is happening. Add this more than once to make things
193 even more verbose.
194 .TP
195 .B \-x
196 Eject the CD when all tracks have been read. See the EJECTCD configuration
197 variable.
198 .TP
199 .B \-X [cue2discid]
200 Use an alternative "cue2discid" implementation. The name of the binary must be
201 exactly that. \fBabcde\fR comes with an implementation in python under the examples
202 directory. The special keyword "builtin" forces the usage of the internal
203 (default) implementation in shell script.
204 .TP
205 .B \-w [comment]
206 Add a comment to the tracks ripped from the CD. If you wish to use
207 parentheses, these will need to be escaped. i.e. you have to write
208 "\\(" instead of "(".
209 .TP
210 .B \-W [number]
211 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
212 to modify the numbering of the tracks, starting with "#01". For Ogg/Vorbis and
213 FLAC files, it also defines a DISCNUMBER tag.
214 .TP
215 .B \-z
216 DEBUG mode: it will rip, using \fBcdparanoia\fR, the very first second of each track
217 and proceed with the actions requested very quickly, also providing some
218 "hidden" information about what happens on the background. CAUTION: IT WILL
219 ERASE ANY EXISTING RIPS WITHOUT WARNING!
220 .TP
221 .B [tracks]
222 A list of tracks you want \fBabcde\fR to process. If this isn't specified, \fBabcde\fR
223 will process the entire CD. Accepts ranges of track numbers -
224 "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
225 .SH OUTPUT
226 Each track is, by default, placed in a separate file named after the track in a
227 subdirectory named after the artist under the current directory. This can be
228 modified using the OUTPUTFORMAT and VAOUTPUTFORMAT variables in your
229 \fIabcde.conf\fR. Each file is given an extension identifying  its compression
230 format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.wav', '.wv',
231 \(aq.ape', '.opus' or '.mka'.
232 .SH CONFIGURATION
233 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
234 \fI$HOME/.abcde.conf\fR, in that order.
235 .PP
236 The configuration options stated in those files can be overridden by providing
237 the appropriate flags at runtime.
238 .PP
239 The configuration variables have to be set as follows:
240 .TP
241 .B VARIABLE=value
242 Except when "value" needs to be quoted or otherwise interpreted. If other
243 variables within "value" are to be expanded upon reading the configuration
244 file, then double quotes should be used. If they are only supposed to be
245 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
246 .TP
247 All shell escaping/quoting rules apply.
248 .TP
249 Here is a list of options \fBabcde\fR recognizes:
250 .TP
251 .B CDDBMETHOD
252 Specifies the method we want to use to retrieve the track information. Two
253 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
254 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
255 the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
256 conversation with the Musicbrainz server for information retrieval.
257 .TP
258 .B CDDBURL
259 Specifies a server to use for CDDB lookups.
260 .TP
261 .B CDDBPROTO
262 Specifies the protocol version used for the CDDB retrieval of results. Version
263 6 retrieves CDDB entries in UTF-8 format.
264 .TP
265 .B HELLOINFO
266 Specifies the Hello information to send to the CDDB server. The CDDB
267 protocol requires you to send a valid username and hostname each time you
268 connect. The format of this is username@hostname.
269 .TP
270 .B CDDBLOCALDIR
271 Specifies a directory where we store a local CDDB repository. The entries must
272 be standard CDDB entries, with the filename being the DISCID value. Other
273 CD playing and ripping programs (like Grip) store the entries under \fI~/.cddb\fR
274 and we can make use of those entries.
275 .TP
276 .B CDDBLOCALRECURSIVE
277 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
278 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
279 is selected, it will be copied to the root of the CDDBLOCALDIR if
280 CDDBLOCALPOLICY is "modified" or "new". The default "y" is needed for the local
281 CDDB search to work.
282 .TP
283 .B CDDBLOCALPOLICY
284 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
285 possible policies are: "net" for a CDDB entry which has been received from the
286 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
287 was received from the net, but will request confirmation to overwrite a local
288 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
289 CDDB entry found in the local repository but which has been modified by the
290 user; and "always" which forces the CDDB entry to be stored back in the root of
291 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
292 This last option will always overwrite the one found in the root of the local
293 repository (if any). STILL NOT WORKING!!
294 .TP
295 .B CDDBCOPYLOCAL
296 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
297 .TP
298 .B CDDBUSELOCAL
299 Actually use the stored copies of the CDDB entries. Can be overridden using the
300 "\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
301 the choice of retrieving a CDDB entry from the internet.
302 .TP
303 .B SHOWCDDBFIELDS
304 Coma-separated list of fields we want to parse during the CDDB parsing.
305 Defaults to "year,genre".
306 .TP
307 .B OGGENCODERSYNTAX
308 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
309 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
310 This affects the default location of the binary,
311 the variable to pick encoder command-line options from, and where the options
312 are given.
313 .TP
314 .B MP3ENCODERSYNTAX
315 Specifies the style of encoder to use for the MP3 encoder. Valid options are
316 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
317 Affects the same way as explained above for Ogg/Vorbis.
318 .TP
319 .B FLACENCODERSYNTAX
320 Specifies the style of encoder to use for the FLAC encoder. At this point only
321 \'flac\' is available for FLAC encoding.
322 .TP
323 .B MP2ENCODERSYNTAX
324 Specifies the style of encoder to use for the MPEG-1 Audio Layer II (MP2) encoder.
325 At this point both \'twolame\' and \'ffmpeg\' are available for MP2 encoding.
326 .TP
327 .B SPEEXENCODERSYNTAX
328 Specifies the style of encoder to use for Speex encoder. At this point only
329 \'speexenc\' is available for Ogg/Speex encoding.
330 .TP
331 .B MPCENCODERSYNTAX
332 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
333 point we only have \'mpcenc\' available, from musepack.net.
334 .TP
335 .B AACENCODERSYNTAX
336 Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
337 as \'default\' as well as higher quality audio with neroAacEnc, fdkaac, qaac,fhgaacenc
338 and FFmpeg or avconv. If qaac, refalac or FFmpeg / avconv are used it is also possible
339 to generate Apple Lossless Audio Codec (alac) files. Note that qaac, refalac and fhgaacenc
340 are Windows applications which require Wine to be installed.
341 .TP
342 .B TTAENCODERSYNTAX
343 Specifies the style of encoder to use for True Audio (tts) encoding. We
344 support \'tta\' as default but the older \'ttaenc\' can be used as well.
345 .TP
346 .B WVENCODERSYNTAX
347 Specifies the style of encoder to use for WavPack. We support \'wavpack\'
348 as \'default\' but \'ffmpeg'\ is the other option (Note that this is for
349 FFmpeg only as avconv does not have a native WavPack encoder).
350 .TP
351 .B APENCODERSYNTAX
352 Specifies the style of encoder to use for Monkey's Audio (ape). We support \'mac\',
353 Monkey's Audio Console, as \'default\'.
354 .TP
355 .B OPUSENCODERSYNTAX
356 Specifies the style of encoder to use for the Opus encoder. At this point only
357 \'opusenc\' is available for Opus encoding.
358 .TP
359 .B MKAENCODERSYNTAX
360 Specifies the style of encoder to use for the Matroska or mka container. At this
361 point only \'ffmpeg\' is available to utilise the mka container. Safe audio codecs
362 for mka include Vorbis, MP2, MP3, LC-AAC, HE-AAC, WMAv1, WMAv2, AC3, eAC3 and Opus.
363 See the FAQ document for more information.
364 .TP
365 .B NORMALIZERSYNTAX
366 Specifies the style of normalizer to use.  Valid options are \'default\'
367 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
368 ATM.
369 .TP
370 .B CDROMREADERSYNTAX
371 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
372 \'libcdio'\, \'debug\' and \'flac\'. It is used for querying the CDROM and 
373 obtain a list of valid tracks and DATA tracks. The special \'flac\' case is u
374 sed to "rip" CD tracks from a single-track flac file.
375 .TP
376 .B CUEREADERSYNTAX
377 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
378 we only support \'mkcue\', but in the future other readers might be used.
379 .TP
380 .B KEEPWAVS
381 It defaults to no, so if you want to keep those wavs ripped from your CD,
382 set it to "y". You can use the "\-k" switch in the command line. The default
383 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
384 files even you have requested the "clean" action.
385 .TP
386 .B PADTRACKS
387 If set to "y", it adds 0's to the file numbers to complete a two-number
388 holder. Useful when encoding tracks 1-9.
389 .TP
390 .B INTERACTIVE
391 Set to "n" if you want to perform automatic rips, without user intervention.
392 .TP
393 .B NICE VALUES
394 Define the values for priorities (nice values) for the different CPU-hungry
395 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
396 with \fBdistmp3\fR (DISTMP3NICE).
397 .TP
398 .B PATHNAMES
399 The following configuration file options specify the pathnames of their
400 respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
401 VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, WAVEPACK, APENC, OPUSENC, ID3, EYED3,
402 METAFLAC, CDPARANOIA, CD_PARANOIA, CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, 
403 EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, 
404 MPCGAIN, MKCUE, MKTOC, CUE2DISCID (see option "\-X"), DIFF, HTTPGET, GLYRC,
405 IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY, FFMPEG,
406 TWOLAME, MID3V2, TTA and TTAENC.
407 .TP
408 .B COMMAND-LINE OPTIONS
409 If you wish to specify command-line options to any of the programs \fBabcde\fR uses,
410 set the following configuration file options: LAMEOPTS, GOGOOPTS,
411 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WAVEPACKENCOPTS, APENCOPTS,
412 OGGENCOPTS, FLACOPTS, SPEEXENCOPTS, MPCENCOPTS, FAACENCOPTS, NEROAACENCOPTS, FDKAACENCOPTS, 
413 OPUSENCOPTS, ID3OPTS, EYED3OPTS, MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS, PIRDOPTS, 
414 CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, 
415 VORBISCOMMMENTOPTS, METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS, HTTPGETOPTS,
416 GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
417 ATOMICPARSLEYOPTS, FFMPEGENCOPTS, TWOLAMENCOPTS and TTAENCOPTS.
418 .TP
419 .B CDSPEEDVALUE
420 Set the value of the CDROM speed. The default is to read the disc as fast as
421 the reading program and the system permits. The steps are defined as 150kB/s
422 (1x).
423 .TP
424 .B ACTIONS
425 The default actions to be performed when reading a disc.
426 .TP
427 .B CDROM
428 If set, it points to the CD-Rom device which has to be used for audio
429 extraction. Abcde tries to guess the right device, but it may fail. The special
430 \'flac\' option is defined to extract tracks from a single-track flac file.
431 .TP
432 .B CDPARANOIACDROMBUS
433 Defined as "d" when using \fBcdparanoia\fR with an IDE bus and as "g" when using
434 \fBcdparanoia\fR with the ide-scsi emulation layer.
435 .TP
436 .B OUTPUTDIR
437 Specifies the directory to place completed tracks/playlists in.
438 .TP
439 .B WAVOUTPUTDIR
440 Specifies the temporary directory to store .wav files in. Abcde may use up
441 to 700MB of temporary space for each session (although it is rare to use
442 over 100MB for a machine that can encode music as fast as it can read it).
443 .TP
444 .B OUTPUTTYPE
445 Specifies the encoding format to output, as well as the default extension and
446 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
447 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
448 Codec), "mp2" (MPEG-1 Audio Layer III), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack),
449 "m4a" (AAC or ALAC),"wv" (WavPack"), "wav" (Microsoft Waveform), "opus"
450 (Opus Interactive Audio Codec), "tta" (True Audio) or "mka" (Matroska). Values like
451 "vorbis,mp3" encode the tracks in both Ogg/Vorbis and MP3 formats. For example:
452 .br
453 OUTPUTTYPE=vorbis,flac
454 .br
455 For each value in OUTPUTTYPE, \fBabcde\fR expands a different process for encoding,
456 tagging and moving, so you can use the format placeholder, OUTPUT, to create
457 different subdirectories to hold the different types. The variable OUTPUT will
458 be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape', 'tta', 'wav'
459 and/or 'mka' depending on the OUTPUTTYPE you define. For example
460 .br
461 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
462 .TP
463 .B OUTPUTFORMAT
464 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
465 (Musepack) or M4A filenames. Variables are included using standard shell
466 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
467 TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
468 Make sure to use single quotes around this variable. TRACKNUM is automatically
469 zero-padded, when the number of encoded tracks is higher than 9. When lower,
470 you can force with '\-p' in the command line.
471 .TP
472 .B VAOUTPUTFORMAT
473 Just like OUTPUTFORMAT but for Various Artists discs. The default is
474 \(aqVarious-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
475 .TP
476 .B ONETRACKOUTPUTFORMAT
477 Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default
478 is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
479 .TP
480 .B VAONETRACKOUTPUTFORMAT
481 Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default
482 is 'Various-${ALBUMFILE}/${ALBUMFILE}'
483 .TP
484 .B MAXPROCS
485 Defines how many encoders to run at once. This makes for huge speedups
486 on SMP systems. You should run one encoder per CPU at once for maximum
487 efficiency, although more doesn't hurt very much. Set it "0" when using
488 mp3dist to avoid getting encoding processes in the local host.
489 .TP
490 .B LOWDISK
491 If set to y, conserves disk space by encoding tracks immediately after
492 reading them. This is substantially slower than normal operation but
493 requires several hundred MB less space to complete the encoding of an
494 entire CD. Use only if your system is low on space and cannot encode as
495 quickly as it can read.
496
497 Note that this option may also help when reading
498 a CD with errors. This is because on a scratchy disk reading is quite timing
499 sensitive and this option reduces the background load on the system which
500 allows the ripping program more precise control.
501 .TP
502 .B BATCHNORM
503 If set to y, enables batch mode normalization, which preserves relative
504 volume differences between tracks of an album. Also enables nogap encoding
505 when using the \'lame\' encoder.
506 .TP
507 .B NOGAP
508 Activate the lame's \-\-nogap option, that allows files found in CDs with no
509 silence between songs (such as live concerts) to be encoded without noticeable
510 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag.  This tag is
511 required for mp3 players to correctly display track lengths when playing
512 variable-bit-rate mp3 files.
513 .TP
514 .B PLAYLISTFORMAT
515 Specifies the format for completed playlist filenames. Works like the
516 OUTPUTFORMAT configuration variable. Default is
517 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
518 Make sure to use single quotes around this variable.
519 .TP
520 .B PLAYLISTDATAPREFIX
521 Specifies a prefix for filenames within a playlist. Useful for http
522 playlists, etc.
523 .TP
524 .B DOSPLAYLIST
525 If set, the resulting playlist will have CR-LF line endings, needed by some
526 hardware-based players.
527 .TP
528 .B COMMENT
529 Specifies a comment to embed in the ID3 or Ogg comment field of each
530 finished track. Can be up to 28 characters long. Supports the same
531 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
532 .TP
533 .B REMOTEHOSTS
534 Specifies a comma-delimited list of systems to use for remote encoding using
535 \fBdistmp3\fR. Equivalent to \-r.
536 .TP
537 .B mungefilename
538 mungefilename() is an \fBabcde\fR shell function that can be overridden via
539 \fIabcde.conf\fR. It takes CDDB data as $1 and outputs the resulting filename on
540 stdout. It defaults to deleting any preceding dots to filename, replacing spaces
541 with an underscore and eating characters which variously Windows and Linux do
542 not permit.
543 .br
544 If you modify this function, it is probably a good idea to keep the forward
545 slash munging (UNIX cannot store a file with a '/' char in it) as well as
546 the control character munging (NULs can't be in a filename either, and
547 newlines and such in filenames are typically not desirable).
548 .br
549 New to abcde 2.7.3 are the user definable functions mungetrackname, mungeartistname
550 and mungealbumname which default to mungefilename. These permit finer-grained
551 control of track name, artist name and album name for the ultra-fastidious.
552 .TP
553 .B mungegenre
554 mungegenre () is a shell function used to modify the $GENRE variable. As
555 a default action, it takes $GENRE as $1 and outputs the resulting value
556 to stdout converting all UPPERCASE characters to lowercase.
557 .TP
558 .B pre_read
559 pre_read () is a shell function which is executed before the CDROM is read
560 for the first time, during \fBabcde\fR execution. It can be used to close the CDROM
561 tray, to set its speed (via "setcd" or via "eject", if available) and other
562 preparation actions. The default function is empty.
563 .TP
564 .B post_read
565 post_read () is a shell function which is executed after the CDROM is read
566 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
567 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
568 The default function is empty.
569 .TP
570 .B EJECTCD
571 If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
572 after all tracks have been read. It has no effect when CDROM is set to a flac
573 file.
574 .TP
575 .B EXTRAVERBOSE
576 If set to "1", some operations which are usually now shown to the end user
577 are visible, such as CDDB queries. Useful for initial debug and if your
578 network/CDDB server is slow. Set to "2" or more for even more verbose
579 output.
580 .SH EXAMPLES
581 Possible ways one can call \fBabcde\fR:
582 .TP
583 .B abcde
584 Will work in most systems
585 .TP
586 .B abcde \-d /dev/cdrom2
587 If the CDROM you are reading from is not the standard \fI/dev/cdrom\fR (in GNU/Linux systems)
588 .TP
589 .B abcde \-o vorbis,flac
590 Will create both Ogg/Vorbis and Ogg/FLAC files.
591 .TP
592 .B abcde \-o vorbis:"-b 192"
593 Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
594 config file
595 .TP
596 .B abcde \-W 1
597 For double+ CD settings: will create the 1st CD starting with the track number
598 101, and will add a comment "CD 1" to the tracks, the second starting with 201
599 and so on.
600 .TP
601 .B abcde \-d singletrack.flac -o vorbis:"-q 6"
602 Will extract the files contained in singletrack FLAC file using the embedded
603 cuesheet and then encode the output files to Ogg/Vorbis with a quality setting of 6.
604 .SH BACKEND TOOLS
605 \fBabcde\fR requires the following backend tools to work:
606 .TP
607 .B *
608 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A encoder or Opus encoder 
609 (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc, faac, 
610 neroAacEnc, fdkaac, wavpack, opusenc).
611 .TP
612 .B *
613 An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
614 pird, dagrab). To read CD-TEXT information, icedax or cdda2wav will be needed.
615 .TP
616 .B *
617 cd-discid, a CDDB DiscID reading program.
618 .TP
619 .B *
620 An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X,
621 among others). Alternatively, abcde-musicbrainz-tool (which depends on
622 Perl and some Musicbrainz libraries) can be used to retrieve CDDB
623 information about the CD.
624 .TP
625 .B *
626 (for MP3s) id3 or eyeD3, id3 v1 and v2 tagging programs.
627 .TP
628 .B *
629 For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
630 .TP
631 .B *
632 To retrieve album art a glyrc package is required and optionally the
633 ImageMagick package should be installed.
634 .TP
635 .B *
636 (optional) distmp3, a client/server for distributed mp3 encoding.
637 .TP
638 .B *
639 (optional) normalize-audio, a WAV file volume normalizer.
640 .TP
641 .B *
642 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, mpcgain, wvgain),
643 .TP
644 .B *
645 (optional) mkcue, a CD cuesheet extractor.
646 .SH "SEE ALSO"
647 .BR cdparanoia (1),
648 .BR cd-paranoia (1)
649 .BR icedax (1),
650 .BR cdda2wav (1),
651 .BR twolame (1),
652 .BR mid3v2 (1),
653 .BR pird (1),
654 .BR dagrab (1),
655 .BR normalize-audio (1),
656 .BR oggenc (1),
657 .BR vorbize (1),
658 .BR flac (1),
659 .BR speexenc (1),
660 .BR mpcenc (1),
661 .BR faac (1),
662 .BR fdkaac (1),
663 .BR identify (1),
664 .BR display (1),
665 .BR convert (1),
666 .BR wavpack (1),
667 .BR wvgain (1),
668 .BR id3 (1),
669 .BR eyeD3 (1),
670 .BR wget (1),
671 .BR fetch (1),
672 .BR cd-discid (1),
673 .BR distmp3 (1),
674 .BR distmp3host (1),
675 .BR curl (1),
676 .BR mkcue (1),
677 .BR vorbisgain (1),
678 .BR mp3gain (1)
679 .SH AUTHORS
680 Robert Woodcock <rcw@debian.org>,
681 Jesus Climent <jesus.climent@hispalinux.es>,
682 Colin Tuckley <colint@debian.org>,
683 Steve McIntyre <93sam@debian.org>,
684 Andrew Strong <andrew.david.strong@gmail.com> and contributions from many others.