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