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