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