Remove the TODO document
[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) 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 Monkey's Audio (ape) 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 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) and/or Opus format(s), 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" or "opus".  Specify a comma-delimited list of output types to obtain
151 all specified types.  See the OUTPUTTYPE configuration variable. One can pass
152 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', 'ape' or '.opus'.
231 .SH CONFIGURATION
232 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
233 \fI$HOME/.abcde.conf\fR, in that order.
234 .PP
235 The configuration options stated in those files can be overridden by providing
236 the appropriate flags at runtime.
237 .PP
238 The configuration variables have to be set as follows:
239 .TP
240 .B VARIABLE=value
241 Except when "value" needs to be quoted or otherwise interpreted. If other
242 variables within "value" are to be expanded upon reading the configuration
243 file, then double quotes should be used. If they are only supposed to be
244 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
245 .TP
246 All shell escaping/quoting rules apply.
247 .TP
248 Here is a list of options \fBabcde\fR recognizes:
249 .TP
250 .B CDDBMETHOD
251 Specifies the method we want to use to retrieve the track information. Two
252 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
253 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
254 the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
255 conversation with the Musicbrainz server for information retrieval.
256 .TP
257 .B CDDBURL
258 Specifies a server to use for CDDB lookups.
259 .TP
260 .B CDDBPROTO
261 Specifies the protocol version used for the CDDB retrieval of results. Version
262 6 retrieves CDDB entries in UTF-8 format.
263 .TP
264 .B HELLOINFO
265 Specifies the Hello information to send to the CDDB server. The CDDB
266 protocol requires you to send a valid username and hostname each time you
267 connect. The format of this is username@hostname.
268 .TP
269 .B CDDBLOCALDIR
270 Specifies a directory where we store a local CDDB repository. The entries must
271 be standard CDDB entries, with the filename being the DISCID value. Other
272 CD playing and ripping programs (like Grip) store the entries under \fI~/.cddb\fR
273 and we can make use of those entries.
274 .TP
275 .B CDDBLOCALRECURSIVE
276 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
277 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
278 is selected, it will be copied to the root of the CDDBLOCALDIR if
279 CDDBLOCALPOLICY is "modified" or "new". The default "y" is needed for the local
280 CDDB search to work.
281 .TP
282 .B CDDBLOCALPOLICY
283 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
284 possible policies are: "net" for a CDDB entry which has been received from the
285 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
286 was received from the net, but will request confirmation to overwrite a local
287 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
288 CDDB entry found in the local repository but which has been modified by the
289 user; and "always" which forces the CDDB entry to be stored back in the root of
290 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
291 This last option will always overwrite the one found in the root of the local
292 repository (if any). STILL NOT WORKING!!
293 .TP
294 .B CDDBCOPYLOCAL
295 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
296 .TP
297 .B CDDBUSELOCAL
298 Actually use the stored copies of the CDDB entries. Can be overridden using the
299 "\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
300 the choice of retrieving a CDDB entry from the internet.
301 .TP
302 .B SHOWCDDBFIELDS
303 Coma-separated list of fields we want to parse during the CDDB parsing.
304 Defaults to "year,genre".
305 .TP
306 .B OGGENCODERSYNTAX
307 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
308 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
309 This affects the default location of the binary,
310 the variable to pick encoder command-line options from, and where the options
311 are given.
312 .TP
313 .B MP3ENCODERSYNTAX
314 Specifies the style of encoder to use for the MP3 encoder. Valid options are
315 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
316 Affects the same way as explained above for Ogg/Vorbis.
317 .TP
318 .B FLACENCODERSYNTAX
319 Specifies the style of encoder to use for the FLAC encoder. At this point only
320 \'flac\' is available for FLAC encoding.
321 .TP
322 .B SPEEXENCODERSYNTAX
323 Specifies the style of encoder to use for Speex encoder. At this point only
324 \'speexenc\' is available for Ogg/Speex encoding.
325 .TP
326 .B MPCENCODERSYNTAX
327 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
328 point we only have \'mpcenc\' available, from musepack.net.
329 .TP
330 .B AACENCODERSYNTAX
331 Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
332 as \'default\' as well as higher quality audio with neroAacEnc and fdkaac.
333 .TP
334 .B WVENCODERSYNTAX
335 Specifies the style of encoder to use for WavPack. We support \'wavpack\'
336 as \'default\'.
337 .TP
338 .B APENCODERSYNTAX
339 Specifies the style of encoder to use for Monkey's Audio (ape). We support \'mac\',
340 Monkey's Audio Console, as \'default\'.
341 .TP
342 .B OPUSENCODERSYNTAX
343 Specifies the style of encoder to use for the Opus encoder. At this point only
344 \'opusenc\' is available for Opus encoding.
345 .TP
346 .B NORMALIZERSYNTAX
347 Specifies the style of normalizer to use.  Valid options are \'default\'
348 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
349 ATM.
350 .TP
351 .B CDROMREADERSYNTAX
352 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
353 \'libcdio'\, \'debug\' and \'flac\'. It is used for querying the CDROM and 
354 obtain a list of valid tracks and DATA tracks. The special \'flac\' case is u
355 sed to "rip" CD tracks from a single-track flac file.
356 .TP
357 .B CUEREADERSYNTAX
358 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
359 we only support \'mkcue\', but in the future other readers might be used.
360 .TP
361 .B KEEPWAVS
362 It defaults to no, so if you want to keep those wavs ripped from your CD,
363 set it to "y". You can use the "\-k" switch in the command line. The default
364 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
365 files even you have requested the "clean" action.
366 .TP
367 .B PADTRACKS
368 If set to "y", it adds 0's to the file numbers to complete a two-number
369 holder. Useful when encoding tracks 1-9.
370 .TP
371 .B INTERACTIVE
372 Set to "n" if you want to perform automatic rips, without user intervention.
373 .TP
374 .B NICE VALUES
375 Define the values for priorities (nice values) for the different CPU-hungry
376 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
377 with \fBdistmp3\fR (DISTMP3NICE).
378 .TP
379 .B PATHNAMES
380 The following configuration file options specify the pathnames of their
381 respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
382 VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, AACENC, WVENC, APENC, OPUSENC, ID3, EYED3,
383 METAFLAC, CDPARANOIA, CD_PARANOIA, CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, 
384 EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, 
385 MPCGAIN, MKCUE, MKTOC, CUE2DISCID (see option "\-X"), DIFF, HTTPGET, GLYRC,
386 IDENTIFY, DISPLAYCMD and CONVERT.
387 .TP
388 .B COMMAND-LINE OPTIONS
389 If you wish to specify command-line options to any of the programs \fBabcde\fR uses,
390 set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
391 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WVENCOPTS, APENCOPTS,
392 OGGENCOPTS, FLACOPTS, SPEEXENCOPTS, MPCENCOPTS, FAACENCOPTS, NEROAACENCOPTS, FDKAACENCOPTS, 
393 OPUSENCOPTS, ID3OPTS, EYED3OPTS, MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS, PIRDOPTS, 
394 CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, 
395 VORBISCOMMMENTOPTS, METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS, HTTPGETOPTS,
396 GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS and DISPLAYCMDOPTS.
397 .TP
398 .B CDSPEEDVALUE
399 Set the value of the CDROM speed. The default is to read the disc as fast as
400 the reading program and the system permits. The steps are defined as 150kB/s
401 (1x).
402 .TP
403 .B ACTIONS
404 The default actions to be performed when reading a disc.
405 .TP
406 .B CDROM
407 If set, it points to the CD-Rom device which has to be used for audio
408 extraction. Abcde tries to guess the right device, but it may fail. The special
409 \'flac\' option is defined to extract tracks from a single-track flac file.
410 .TP
411 .B CDPARANOIACDROMBUS
412 Defined as "d" when using \fBcdparanoia\fR with an IDE bus and as "g" when using
413 \fBcdparanoia\fR with the ide-scsi emulation layer.
414 .TP
415 .B OUTPUTDIR
416 Specifies the directory to place completed tracks/playlists in.
417 .TP
418 .B WAVOUTPUTDIR
419 Specifies the temporary directory to store .wav files in. Abcde may use up
420 to 700MB of temporary space for each session (although it is rare to use
421 over 100MB for a machine that can encode music as fast as it can read it).
422 .TP
423 .B OUTPUTTYPE
424 Specifies the encoding format to output, as well as the default extension and
425 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
426 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
427 Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)), "m4a" (AAC)),
428 "wv" (WavPack", "wav" (Microsoft Waveform) or "opus" (Opus Interactive Audio Codec). Values
429 like "vorbis,mp3" encode the tracks in both Ogg/Vorbis and MP3 formats. For example
430 .br
431 OUTPUTTYPE=vorbis,flac
432 .br
433 For each value in OUTPUTTYPE, \fBabcde\fR expands a different process for encoding,
434 tagging and moving, so you can use the format placeholder, OUTPUT, to create
435 different subdirectories to hold the different types. The variable OUTPUT will
436 be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', 'wv', 'ape' and/or 'wav', depending on the
437 OUTPUTTYPE you define. For example
438 .br
439 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
440 .TP
441 .B OUTPUTFORMAT
442 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
443 (Musepack) or M4A filenames. Variables are included using standard shell
444 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
445 TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
446 Make sure to use single quotes around this variable. TRACKNUM is automatically
447 zero-padded, when the number of encoded tracks is higher than 9. When lower,
448 you can force with '\-p' in the command line.
449 .TP
450 .B VAOUTPUTFORMAT
451 Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
452 .TP
453 .B ONETRACKOUTPUTFORMAT
454 Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
455 .TP
456 .B VAONETRACKOUTPUTFORMAT
457 Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
458 .TP
459 .B MAXPROCS
460 Defines how many encoders to run at once. This makes for huge speedups
461 on SMP systems. You should run one encoder per CPU at once for maximum
462 efficiency, although more doesn't hurt very much. Set it "0" when using
463 mp3dist to avoid getting encoding processes in the local host.
464 .TP
465 .B LOWDISK
466 If set to y, conserves disk space by encoding tracks immediately after
467 reading them. This is substantially slower than normal operation but
468 requires several hundred MB less space to complete the encoding of an
469 entire CD. Use only if your system is low on space and cannot encode as
470 quickly as it can read.
471
472 Note that this option may also help when reading
473 a CD with errors. This is because on a scratchy disk reading is quite timing
474 sensitive and this option reduces the background load on the system which
475 allows the ripping program more precise control.
476 .TP
477 .B BATCHNORM
478 If set to y, enables batch mode normalization, which preserves relative
479 volume differences between tracks of an album. Also enables nogap encoding
480 when using the \'lame\' encoder.
481 .TP
482 .B NOGAP
483 Activate the lame's \-\-nogap option, that allows files found in CDs with no
484 silence between songs (such as live concerts) to be encoded without noticeable
485 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag.  This tag is
486 required for mp3 players to correctly display track lengths when playing
487 variable-bit-rate mp3 files.
488 .TP
489 .B PLAYLISTFORMAT
490 Specifies the format for completed playlist filenames. Works like the
491 OUTPUTFORMAT configuration variable. Default is
492 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
493 Make sure to use single quotes around this variable.
494 .TP
495 .B PLAYLISTDATAPREFIX
496 Specifies a prefix for filenames within a playlist. Useful for http
497 playlists, etc.
498 .TP
499 .B DOSPLAYLIST
500 If set, the resulting playlist will have CR-LF line endings, needed by some
501 hardware-based players.
502 .TP
503 .B COMMENT
504 Specifies a comment to embed in the ID3 or Ogg comment field of each
505 finished track. Can be up to 28 characters long. Supports the same
506 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
507 .TP
508 .B REMOTEHOSTS
509 Specifies a comma-delimited list of systems to use for remote encoding using
510 \fBdistmp3\fR. Equivalent to \-r.
511 .TP
512 .B mungefilename
513 mungefilename() is an \fBabcde\fR shell function that can be overridden via
514 \fIabcde.conf\fR. It takes CDDB data as $1 and outputs the resulting filename on
515 stdout. It defaults to eating control characters, apostrophes and
516 question marks, translating spaces and forward slashes to underscores, and
517 translating colons to an underscore and a hyphen.
518 .br
519 If you modify this function, it is probably a good idea to keep the forward
520 slash munging (UNIX cannot store a file with a '/' char in it) as well as
521 the control character munging (NULs can't be in a filename either, and
522 newlines and such in filenames are typically not desirable).
523 .TP
524 .B mungegenre
525 mungegenre () is a shell function used to modify the $GENRE variable. As
526 a default action, it takes $GENRE as $1 and outputs the resulting value
527 to stdout converting all UPPERCASE characters to lowercase.
528 .TP
529 .B pre_read
530 pre_read () is a shell function which is executed before the CDROM is read
531 for the first time, during \fBabcde\fR execution. It can be used to close the CDROM
532 tray, to set its speed (via "setcd" or via "eject", if available) and other
533 preparation actions. The default function is empty.
534 .TP
535 .B post_read
536 post_read () is a shell function which is executed after the CDROM is read
537 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
538 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
539 The default function is empty.
540 .TP
541 .B EJECTCD
542 If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
543 after all tracks have been read. It has no effect when CDROM is set to a flac
544 file.
545 .TP
546 .B EXTRAVERBOSE
547 If set to "1", some operations which are usually now shown to the end user
548 are visible, such as CDDB queries. Useful for initial debug and if your
549 network/CDDB server is slow. Set to "2" or more for even more verbose
550 output.
551 .SH EXAMPLES
552 Possible ways one can call \fBabcde\fR:
553 .TP
554 .B abcde
555 Will work in most systems
556 .TP
557 .B abcde \-d /dev/cdrom2
558 If the CDROM you are reading from is not the standard \fI/dev/cdrom\fR (in GNU/Linux systems)
559 .TP
560 .B abcde \-o vorbis,flac
561 Will create both Ogg/Vorbis and Ogg/FLAC files.
562 .TP
563 .B abcde \-o vorbis:"-b 192"
564 Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
565 config file
566 .TP
567 .B abcde \-W 1
568 For double+ CD settings: will create the 1st CD starting with the track number
569 101, and will add a comment "CD 1" to the tracks, the second starting with 201
570 and so on.
571 .TP
572 .B abcde \-d singletrack.flac
573 Will extract the files contained in singletrack using the embedded cuesheet.
574 .SH BACKEND TOOLS
575 \fBabcde\fR requires the following backend tools to work:
576 .TP
577 .B *
578 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A encoder or Opus encoder 
579 (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc, faac, 
580 neroAacEnc, fdkaac, wavpack, opusenc).
581 .TP
582 .B *
583 An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
584 pird, dagrab). To read CD-TEXT information, icedax or cdda2wav will be needed.
585 .TP
586 .B *
587 cd-discid, a CDDB DiscID reading program.
588 .TP
589 .B *
590 An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X,
591 among others). Alternatively, abcde-musicbrainz-tool (which depends on
592 Perl and some Musicbrainz libraries) can be used to retrieve CDDB
593 information about the CD.
594 .TP
595 .B *
596 (for MP3s) id3 or eyeD3, id3 v1 and v2 tagging programs.
597 .TP
598 .B *
599 For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
600 .TP
601 .B *
602 To retrieve album art a glyrc package is required and optionally the
603 ImageMagick package should be installed.
604 .TP
605 .B *
606 (optional) distmp3, a client/server for distributed mp3 encoding.
607 .TP
608 .B *
609 (optional) normalize-audio, a WAV file volume normalizer.
610 .TP
611 .B *
612 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, mpcgain, wvgain),
613 .TP
614 .B *
615 (optional) mkcue, a CD cuesheet extractor.
616 .SH "SEE ALSO"
617 .BR cdparanoia (1),
618 .BR cd-paranoia (1)
619 .BR icedax (1),
620 .BR cdda2wav (1),
621 .BR pird (1),
622 .BR dagrab (1),
623 .BR normalize-audio (1),
624 .BR oggenc (1),
625 .BR vorbize (1),
626 .BR flac (1),
627 .BR toolame (1),
628 .BR speexenc (1),
629 .BR mpcenc (1),
630 .BR faac (1),
631 .BR fdkaac (1),
632 .BR identify (1),
633 .BR display (1),
634 .BR convert (1),
635 .BR wavpack (1),
636 .BR wvgain (1),
637 .BR id3 (1),
638 .BR eyeD3 (1),
639 .BR wget (1),
640 .BR fetch (1),
641 .BR cd-discid (1),
642 .BR distmp3 (1),
643 .BR distmp3host (1),
644 .BR curl (1),
645 .BR mkcue (1),
646 .BR vorbisgain (1),
647 .BR mp3gain (1)
648 .SH AUTHORS
649 Robert Woodcock <rcw@debian.org>,
650 Jesus Climent <jesus.climent@hispalinux.es>,
651 Colin Tuckley <colint@debian.org>,
652 Steve McIntyre <93sam@debian.org> and contributions from many others.