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