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