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