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