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