97343a4298e90dbdb86bf162550f9102124bd841
[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) 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 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) 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" or "opus".  Specify a comma-delimited list of output types to obtain
151 all specified types.  See the OUTPUTTYPE configuration variable. One can pass
152 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', 'ape' or '.opus'.
231 .SH CONFIGURATION
232 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
233 \fI$HOME/.abcde.conf\fR, in that order.
234 .PP
235 The configuration options stated in those files can be overridden by providing
236 the appropriate flags at runtime.
237 .PP
238 The configuration variables have to be set as follows:
239 .TP
240 .B VARIABLE=value
241 Except when "value" needs to be quoted or otherwise interpreted. If other
242 variables within "value" are to be expanded upon reading the configuration
243 file, then double quotes should be used. If they are only supposed to be
244 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
245 .TP
246 All shell escaping/quoting rules apply.
247 .TP
248 Here is a list of options \fBabcde\fR recognizes:
249 .TP
250 .B CDDBMETHOD
251 Specifies the method we want to use to retrieve the track information. Two
252 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
253 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
254 the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
255 conversation with the Musicbrainz server for information retrieval.
256 .TP
257 .B CDDBURL
258 Specifies a server to use for CDDB lookups.
259 .TP
260 .B CDDBPROTO
261 Specifies the protocol version used for the CDDB retrieval of results. Version
262 6 retrieves CDDB entries in UTF-8 format.
263 .TP
264 .B HELLOINFO
265 Specifies the Hello information to send to the CDDB server. The CDDB
266 protocol requires you to send a valid username and hostname each time you
267 connect. The format of this is username@hostname.
268 .TP
269 .B CDDBLOCALDIR
270 Specifies a directory where we store a local CDDB repository. The entries must
271 be standard CDDB entries, with the filename being the DISCID value. Other
272 CD playing and ripping programs (like Grip) store the entries under \fI~/.cddb\fR
273 and we can make use of those entries.
274 .TP
275 .B CDDBLOCALRECURSIVE
276 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
277 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
278 is selected, it will be copied to the root of the CDDBLOCALDIR if
279 CDDBLOCALPOLICY is "modified" or "new". The default "y" is needed for the local
280 CDDB search to work.
281 .TP
282 .B CDDBLOCALPOLICY
283 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
284 possible policies are: "net" for a CDDB entry which has been received from the
285 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
286 was received from the net, but will request confirmation to overwrite a local
287 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
288 CDDB entry found in the local repository but which has been modified by the
289 user; and "always" which forces the CDDB entry to be stored back in the root of
290 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
291 This last option will always overwrite the one found in the root of the local
292 repository (if any). STILL NOT WORKING!!
293 .TP
294 .B CDDBCOPYLOCAL
295 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
296 .TP
297 .B CDDBUSELOCAL
298 Actually use the stored copies of the CDDB entries. Can be overridden using the
299 "\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
300 the choice of retrieving a CDDB entry from the internet.
301 .TP
302 .B SHOWCDDBFIELDS
303 Coma-separated list of fields we want to parse during the CDDB parsing.
304 Defaults to "year,genre".
305 .TP
306 .B OGGENCODERSYNTAX
307 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
308 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
309 This affects the default location of the binary,
310 the variable to pick encoder command-line options from, and where the options
311 are given.
312 .TP
313 .B MP3ENCODERSYNTAX
314 Specifies the style of encoder to use for the MP3 encoder. Valid options are
315 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
316 Affects the same way as explained above for Ogg/Vorbis.
317 .TP
318 .B FLACENCODERSYNTAX
319 Specifies the style of encoder to use for the FLAC encoder. At this point only
320 \'flac\' is available for FLAC encoding.
321 .TP
322 .B MP2ENCODERSYNTAX
323 Specifies the style of encoder to use for the MPEG-1 Audio Layer II (MP2) encoder.
324 At this point both \'twolame\' and \'ffmpeg\' are available for MP2 encoding.
325 .TP
326 .B SPEEXENCODERSYNTAX
327 Specifies the style of encoder to use for Speex encoder. At this point only
328 \'speexenc\' is available for Ogg/Speex encoding.
329 .TP
330 .B MPCENCODERSYNTAX
331 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
332 point we only have \'mpcenc\' available, from musepack.net.
333 .TP
334 .B AACENCODERSYNTAX
335 Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
336 as \'default\' as well as higher quality audio with neroAacEnc, fdkaac, qaac,fhgaacenc
337 and FFmpeg or avconv. If qaac, refalac or FFmpeg / avconv are used it is also possible
338 to generate Apple Lossless Audio Codec (alac) files. Note that qaac, refalac and fhgaacenc
339 are Windows applications which require Wine to be installed.
340 .TP
341 .B WVENCODERSYNTAX
342 Specifies the style of encoder to use for WavPack. We support \'wavpack\'
343 as \'default\' but \'ffmpeg'\ is the other option (Note that this is for
344 FFmpeg only as avconv does not have a native WavPack encoder).
345 .TP
346 .B APENCODERSYNTAX
347 Specifies the style of encoder to use for Monkey's Audio (ape). We support \'mac\',
348 Monkey's Audio Console, as \'default\'.
349 .TP
350 .B OPUSENCODERSYNTAX
351 Specifies the style of encoder to use for the Opus encoder. At this point only
352 \'opusenc\' is available for Opus encoding.
353 .TP
354 .B NORMALIZERSYNTAX
355 Specifies the style of normalizer to use.  Valid options are \'default\'
356 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
357 ATM.
358 .TP
359 .B CDROMREADERSYNTAX
360 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
361 \'libcdio'\, \'debug\' and \'flac\'. It is used for querying the CDROM and 
362 obtain a list of valid tracks and DATA tracks. The special \'flac\' case is u
363 sed to "rip" CD tracks from a single-track flac file.
364 .TP
365 .B CUEREADERSYNTAX
366 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
367 we only support \'mkcue\', but in the future other readers might be used.
368 .TP
369 .B KEEPWAVS
370 It defaults to no, so if you want to keep those wavs ripped from your CD,
371 set it to "y". You can use the "\-k" switch in the command line. The default
372 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
373 files even you have requested the "clean" action.
374 .TP
375 .B PADTRACKS
376 If set to "y", it adds 0's to the file numbers to complete a two-number
377 holder. Useful when encoding tracks 1-9.
378 .TP
379 .B INTERACTIVE
380 Set to "n" if you want to perform automatic rips, without user intervention.
381 .TP
382 .B NICE VALUES
383 Define the values for priorities (nice values) for the different CPU-hungry
384 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
385 with \fBdistmp3\fR (DISTMP3NICE).
386 .TP
387 .B PATHNAMES
388 The following configuration file options specify the pathnames of their
389 respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
390 VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, WAVEPACK, APENC, OPUSENC, ID3, EYED3,
391 METAFLAC, CDPARANOIA, CD_PARANOIA, CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, 
392 EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, 
393 MPCGAIN, MKCUE, MKTOC, CUE2DISCID (see option "\-X"), DIFF, HTTPGET, GLYRC,
394 IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY, FFMPEG,
395 TWOLAME and MID3V2.
396 .TP
397 .B COMMAND-LINE OPTIONS
398 If you wish to specify command-line options to any of the programs \fBabcde\fR uses,
399 set the following configuration file options: LAMEOPTS, GOGOOPTS,
400 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WAVEPACKENCOPTS, APENCOPTS,
401 OGGENCOPTS, FLACOPTS, SPEEXENCOPTS, MPCENCOPTS, FAACENCOPTS, NEROAACENCOPTS, FDKAACENCOPTS, 
402 OPUSENCOPTS, ID3OPTS, EYED3OPTS, MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS, PIRDOPTS, 
403 CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, 
404 VORBISCOMMMENTOPTS, METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS, HTTPGETOPTS,
405 GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
406 ATOMICPARSLEYOPTS, FFMPEGENCOPTS and TWOLAMENCOPTS.
407 .TP
408 .B CDSPEEDVALUE
409 Set the value of the CDROM speed. The default is to read the disc as fast as
410 the reading program and the system permits. The steps are defined as 150kB/s
411 (1x).
412 .TP
413 .B ACTIONS
414 The default actions to be performed when reading a disc.
415 .TP
416 .B CDROM
417 If set, it points to the CD-Rom device which has to be used for audio
418 extraction. Abcde tries to guess the right device, but it may fail. The special
419 \'flac\' option is defined to extract tracks from a single-track flac file.
420 .TP
421 .B CDPARANOIACDROMBUS
422 Defined as "d" when using \fBcdparanoia\fR with an IDE bus and as "g" when using
423 \fBcdparanoia\fR with the ide-scsi emulation layer.
424 .TP
425 .B OUTPUTDIR
426 Specifies the directory to place completed tracks/playlists in.
427 .TP
428 .B WAVOUTPUTDIR
429 Specifies the temporary directory to store .wav files in. Abcde may use up
430 to 700MB of temporary space for each session (although it is rare to use
431 over 100MB for a machine that can encode music as fast as it can read it).
432 .TP
433 .B OUTPUTTYPE
434 Specifies the encoding format to output, as well as the default extension and
435 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
436 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
437 Codec), "mp2" (MPEG-1 Audio Layer III), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack),
438 "m4a" (AAC or ALAC),"wv" (WavPack"), "wav" (Microsoft Waveform) or "opus"
439 (Opus Interactive Audio Codec). Values like "vorbis,mp3" encode the tracks in both
440 Ogg/Vorbis and MP3 formats. For example:
441 .br
442 OUTPUTTYPE=vorbis,flac
443 .br
444 For each value in OUTPUTTYPE, \fBabcde\fR expands a different process for encoding,
445 tagging and moving, so you can use the format placeholder, OUTPUT, to create
446 different subdirectories to hold the different types. The variable OUTPUT will
447 be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape' and/or 'wav', depending on the
448 OUTPUTTYPE you define. For example
449 .br
450 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
451 .TP
452 .B OUTPUTFORMAT
453 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
454 (Musepack) or M4A filenames. Variables are included using standard shell
455 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
456 TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
457 Make sure to use single quotes around this variable. TRACKNUM is automatically
458 zero-padded, when the number of encoded tracks is higher than 9. When lower,
459 you can force with '\-p' in the command line.
460 .TP
461 .B VAOUTPUTFORMAT
462 Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
463 .TP
464 .B ONETRACKOUTPUTFORMAT
465 Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
466 .TP
467 .B VAONETRACKOUTPUTFORMAT
468 Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
469 .TP
470 .B MAXPROCS
471 Defines how many encoders to run at once. This makes for huge speedups
472 on SMP systems. You should run one encoder per CPU at once for maximum
473 efficiency, although more doesn't hurt very much. Set it "0" when using
474 mp3dist to avoid getting encoding processes in the local host.
475 .TP
476 .B LOWDISK
477 If set to y, conserves disk space by encoding tracks immediately after
478 reading them. This is substantially slower than normal operation but
479 requires several hundred MB less space to complete the encoding of an
480 entire CD. Use only if your system is low on space and cannot encode as
481 quickly as it can read.
482
483 Note that this option may also help when reading
484 a CD with errors. This is because on a scratchy disk reading is quite timing
485 sensitive and this option reduces the background load on the system which
486 allows the ripping program more precise control.
487 .TP
488 .B BATCHNORM
489 If set to y, enables batch mode normalization, which preserves relative
490 volume differences between tracks of an album. Also enables nogap encoding
491 when using the \'lame\' encoder.
492 .TP
493 .B NOGAP
494 Activate the lame's \-\-nogap option, that allows files found in CDs with no
495 silence between songs (such as live concerts) to be encoded without noticeable
496 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag.  This tag is
497 required for mp3 players to correctly display track lengths when playing
498 variable-bit-rate mp3 files.
499 .TP
500 .B PLAYLISTFORMAT
501 Specifies the format for completed playlist filenames. Works like the
502 OUTPUTFORMAT configuration variable. Default is
503 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
504 Make sure to use single quotes around this variable.
505 .TP
506 .B PLAYLISTDATAPREFIX
507 Specifies a prefix for filenames within a playlist. Useful for http
508 playlists, etc.
509 .TP
510 .B DOSPLAYLIST
511 If set, the resulting playlist will have CR-LF line endings, needed by some
512 hardware-based players.
513 .TP
514 .B COMMENT
515 Specifies a comment to embed in the ID3 or Ogg comment field of each
516 finished track. Can be up to 28 characters long. Supports the same
517 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
518 .TP
519 .B REMOTEHOSTS
520 Specifies a comma-delimited list of systems to use for remote encoding using
521 \fBdistmp3\fR. Equivalent to \-r.
522 .TP
523 .B mungefilename
524 mungefilename() is an \fBabcde\fR shell function that can be overridden via
525 \fIabcde.conf\fR. It takes CDDB data as $1 and outputs the resulting filename on
526 stdout. It defaults to deleting any preceding dots to filename, replacing spaces
527 with an underscore and eating characters which variously Windows and Linux do
528 not permit.
529 .br
530 If you modify this function, it is probably a good idea to keep the forward
531 slash munging (UNIX cannot store a file with a '/' char in it) as well as
532 the control character munging (NULs can't be in a filename either, and
533 newlines and such in filenames are typically not desirable).
534 .TP
535 .B mungegenre
536 mungegenre () is a shell function used to modify the $GENRE variable. As
537 a default action, it takes $GENRE as $1 and outputs the resulting value
538 to stdout converting all UPPERCASE characters to lowercase.
539 .TP
540 .B pre_read
541 pre_read () is a shell function which is executed before the CDROM is read
542 for the first time, during \fBabcde\fR execution. It can be used to close the CDROM
543 tray, to set its speed (via "setcd" or via "eject", if available) and other
544 preparation actions. The default function is empty.
545 .TP
546 .B post_read
547 post_read () is a shell function which is executed after the CDROM is read
548 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
549 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
550 The default function is empty.
551 .TP
552 .B EJECTCD
553 If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
554 after all tracks have been read. It has no effect when CDROM is set to a flac
555 file.
556 .TP
557 .B EXTRAVERBOSE
558 If set to "1", some operations which are usually now shown to the end user
559 are visible, such as CDDB queries. Useful for initial debug and if your
560 network/CDDB server is slow. Set to "2" or more for even more verbose
561 output.
562 .SH EXAMPLES
563 Possible ways one can call \fBabcde\fR:
564 .TP
565 .B abcde
566 Will work in most systems
567 .TP
568 .B abcde \-d /dev/cdrom2
569 If the CDROM you are reading from is not the standard \fI/dev/cdrom\fR (in GNU/Linux systems)
570 .TP
571 .B abcde \-o vorbis,flac
572 Will create both Ogg/Vorbis and Ogg/FLAC files.
573 .TP
574 .B abcde \-o vorbis:"-b 192"
575 Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
576 config file
577 .TP
578 .B abcde \-W 1
579 For double+ CD settings: will create the 1st CD starting with the track number
580 101, and will add a comment "CD 1" to the tracks, the second starting with 201
581 and so on.
582 .TP
583 .B abcde \-d singletrack.flac -o vorbis:"-q 6"
584 Will extract the files contained in singletrack FLAC file using the embedded
585 cuesheet and then encode the output files to Ogg/Vorbis with a quality setting of 6.
586 .SH BACKEND TOOLS
587 \fBabcde\fR requires the following backend tools to work:
588 .TP
589 .B *
590 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A encoder or Opus encoder 
591 (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc, faac, 
592 neroAacEnc, fdkaac, wavpack, opusenc).
593 .TP
594 .B *
595 An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
596 pird, dagrab). To read CD-TEXT information, icedax or cdda2wav will be needed.
597 .TP
598 .B *
599 cd-discid, a CDDB DiscID reading program.
600 .TP
601 .B *
602 An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X,
603 among others). Alternatively, abcde-musicbrainz-tool (which depends on
604 Perl and some Musicbrainz libraries) can be used to retrieve CDDB
605 information about the CD.
606 .TP
607 .B *
608 (for MP3s) id3 or eyeD3, id3 v1 and v2 tagging programs.
609 .TP
610 .B *
611 For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
612 .TP
613 .B *
614 To retrieve album art a glyrc package is required and optionally the
615 ImageMagick package should be installed.
616 .TP
617 .B *
618 (optional) distmp3, a client/server for distributed mp3 encoding.
619 .TP
620 .B *
621 (optional) normalize-audio, a WAV file volume normalizer.
622 .TP
623 .B *
624 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, mpcgain, wvgain),
625 .TP
626 .B *
627 (optional) mkcue, a CD cuesheet extractor.
628 .SH "SEE ALSO"
629 .BR cdparanoia (1),
630 .BR cd-paranoia (1)
631 .BR icedax (1),
632 .BR cdda2wav (1),
633 .BR twolame (1),
634 .BR mid3v2 (1),
635 .BR pird (1),
636 .BR dagrab (1),
637 .BR normalize-audio (1),
638 .BR oggenc (1),
639 .BR vorbize (1),
640 .BR flac (1),
641 .BR speexenc (1),
642 .BR mpcenc (1),
643 .BR faac (1),
644 .BR fdkaac (1),
645 .BR identify (1),
646 .BR display (1),
647 .BR convert (1),
648 .BR wavpack (1),
649 .BR wvgain (1),
650 .BR id3 (1),
651 .BR eyeD3 (1),
652 .BR wget (1),
653 .BR fetch (1),
654 .BR cd-discid (1),
655 .BR distmp3 (1),
656 .BR distmp3host (1),
657 .BR curl (1),
658 .BR mkcue (1),
659 .BR vorbisgain (1),
660 .BR mp3gain (1)
661 .SH AUTHORS
662 Robert Woodcock <rcw@debian.org>,
663 Jesus Climent <jesus.climent@hispalinux.es>,
664 Colin Tuckley <colint@debian.org>,
665 Steve McIntyre <93sam@debian.org>,
666 Andrew Strong <andrew.david.strong@gmail.com> and contributions from many others.