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