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