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