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