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