Encoding to True Audio (Part 3)
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index dbdcf64..fd9ce13 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -1,6 +1,7 @@
 .TH abcde 1
 .SH NAME
-abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format.
+abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, AAC, 
+WavPack, Monkey's Audio (ape), MPP/MP+(Musepack), True Audio (tta) and/or MP2 format.
 .SH SYNOPSIS
 .B abcde
 .I [options] [tracks]
@@ -9,12 +10,19 @@ Ordinarily, the process of grabbing the data off a CD and encoding it, then
 tagging or commenting it, is very involved.
 .BR abcde
 is designed to automate this. It will take an entire CD and convert it into
-a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III, Free Lossless
-Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack) and/or M4A (AAC) format(s).
+a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III (MP3), Free Lossless
+Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack), M4A (AAC) wv (WavPack), 
+Monkey's Audio (ape), Opus, True Audio (tta) or MPEG Audio Layer II (MP2) format(s).
 With one command, it will:
 .TP
 .B *
-Do a CDDB query over the Internet to look up your CD or use a locally stored CDDB entry
+Do a CDDB or Musicbrainz query over the Internet to look up your CD or
+use a locally stored CDDB entry, or read CD-TEXT from your CD as a
+fallback for track information
+.TP
+.B *
+Download the album art appropriate for your music tracks with many
+user configurable options for download and post download alterations
 .TP
 .B *
 Grab an audio track (or all the audio CD tracks) from your CD
@@ -23,7 +31,8 @@ Grab an audio track (or all the audio CD tracks) from your CD
 Normalize the volume of the individual file (or the album as a single unit)
 .TP
 .B *
-Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) and/or M4A format(s), all in one CD read
+Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A, wv (WavPack), 
+Monkey's Audio (ape), Opus format(s) True Audio (tta) and/or MP2, all in one CD read
 .TP
 .B *
 Comment or ID3/ID3v2 tag
@@ -40,7 +49,7 @@ Delete the intermediate WAV file (or save it for later use)
 .B *
 Repeat until finished
 .P
-Alternatively, 
+Alternatively,
 .B abcde
 can also grab a CD and turn it into a single FLAC file with an embedded
 cuesheet which can be user later on as a source for other formats, and will be
@@ -57,27 +66,23 @@ flac \-a default,cue" for obtaining such a file.
 .TP
 .B \-a [actions]
 Comma-delimited list of actions to perform. Can be one or more of: cddb, cue,
-read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and
-encode imply read. Tag implies cddb, read, encode. Move implies cddb, read,
-encode, tag. Replaygain implies cddb, read, encode, tag and move.  Playlist
-implies cddb. The default is to do all actions except cue, normalize,
-replaygain and playlist.
+read, getalbumart, normalize, encode, tag, move, replaygain, playlist, clean.
+Normalize and encode imply read. Tag implies cddb, read, encode. Move implies
+cddb, read, encode, tag. Replaygain implies cddb, read, encode, tag and move.
+Playlist implies cddb. The default is to do all actions except cue, normalize,
+replaygain, getalbumart and playlist.
 .TP
 .B \-b
 Enable batch mode normalization. See the BATCHNORM configuration variable.
 .TP
-.B \-B
-Disable batch mode replaygain. It processes file by file to add the replaygain
-information. See the NOBATCHREPLAYGAIN configuration variable.
-.TP
 .B \-c [filename]
 Specifies an additional configuration file to parse. Configuration options
-in this file override those in /etc/abcde.conf or $HOME/.abcde.conf.
+in this file override those in \fI/etc/abcde.conf\fR or \fI$HOME/.abcde.conf\fR.
 .TP
 .B \-C [discid]
 Allows you to resume a session for
 .I discid
-when you no longer have the CD available (abcde will automatically resume if
+when you no longer have the CD available (\fBabcde\fR will automatically resume if
 you still have the CD in the drive). You must have already finished at
 least the "read" action during the previous session.
 .TP
@@ -98,7 +103,7 @@ Force the removal of the temporary ABCDETEMPDIR directory, even when we have
 not finished. For example, one can read and encode several formats, including
 \'.ogg\', and later on execute a \'move\' action with only one of the given
 formats. On a normal situation it would erase the rest of those encoded
-formats. In this case, abcde will refuse to execute such command, except if \-f
+formats. In this case, \fBabcde\fR will refuse to execute such command, except if \-f
 is used.
 .TP
 .B \-g
@@ -106,12 +111,18 @@ Enable lame's \-\-nogap option.  See the NOGAP variable. WARNING: lame's
 \-\-nogap disables the Xing mp3 tag.  This tag is required for mp3 players to
 correctly display track lengths when playing variable-bit-rate mp3 files.
 .TP
+.B \-G
+Download album art using the getalbumart function. This is best done with
+CDDBMETHOD set to musicbrainz and requires the installation of glyrc.
+ImageMagick is an optional but highly recommended package. Further details
+of getalbumart can be found in the abcde FAQ document packaged with abcde.
+.TP
 .B \-h
 Get help information.
 .TP
 .B \-j [number]
 Start [number] encoder processes at once. Useful for SMP systems. Overrides
-the MAXPROCS configuration variable. Set it to "0" when using distmp3 to avoid
+the MAXPROCS configuration variable. Set it to "0" when using \fBdistmp3\fR to avoid
 local encoding processes.
 .TP
 .B \-k
@@ -123,6 +134,10 @@ Use the low-diskspace algorithm. See the LOWDISK configuration variable.
 .B \-L
 Use a local CDDB repository. See CDDBLOCALDIR variable.
 .TP
+.B \-m
+Create DOS-style playlists, modifying the resulting one by adding CRLF line
+endings. Some hardware players insist on having those to work.
+.TP
 .B \-n
 Do not query CDDB database. Create and use a template. Edit the template to
 provide song names, artist(s), ...
@@ -130,14 +145,10 @@ provide song names, artist(s), ...
 .B \-N
 Non interactive mode. Do not ask anything from the user. Just go ahead.
 .TP
-.B \-m
-Create DOS-style playlists, modifying the resulting one by adding CRLF line
-endings. Some hardware players insist on having those to work.
-.TP
 .B \-o [filetype][:filetypeoptions]
-Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
-"m4a" or "wav".  Specify a comma-delimited list of output types to obtain all
-specified types.  See the OUTPUTTYPE configuration variable. One can pass
+Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc", "m4a", 
+"wav", "wv", "ape" or "opus".  Specify a comma-delimited list of output types to obtain
+all specified types.  See the OUTPUTTYPE configuration variable. One can pass
 options to the encoder for a specific filetype on the command line separating
 them with a colon. The options must be escaped with double-quotes.
 .TP
@@ -145,22 +156,14 @@ them with a colon. The options must be escaped with double-quotes.
 Pads track numbers with 0\'s.
 .TP
 .B \-P
-Use Unix PIPES to read and encode in one step. It disables multiple encodings,
-since the WAV audio file is never stored in the disc.
-.TP
-.B \-q [quality]
-Use a pre-defined quality level for the encoding process. Defined as low,
-medium or high. The "medium" value is used to reset the default values if other
-are used in the config file(s).
+Use Unix PIPES to read and encode in one step (USEPIPES). This disables multiple
+encodings, since the WAV audio file is never stored in the disc. For more detail
+on this option see the FAQ document in the source tarball.
 .TP
 .B \-r [hosts...]
-Remote encode on this comma-delimited list of machines using distmp3. See
+Remote encode on this comma-delimited list of machines using \fBdistmp3\fR. See
 the REMOTEHOSTS configuration variable.
 .TP
-.B \-R
-When CDDBLOCALDIR and CDDBUSELOCAL are defined, search recursively under the
-defined directory for matches of the CDDB entry.
-.TP
 .B \-s [fields...]
 List, separated by commas, the fields to be shown in the CDDB parsed entries.
 Right now it only uses "year" and "genre".
@@ -185,8 +188,9 @@ information, and we tag and add comments with Latin1 encoding.
 Show the version and exit
 .TP
 .B \-V
-Be a bit more verbose. On slow networks the CDDB requests might give the
-sensation nothing is happening.
+Be more verbose. On slow networks the CDDB requests might give the
+sensation nothing is happening. Add this more than once to make things
+even more verbose.
 .TP
 .B \-x
 Eject the CD when all tracks have been read. See the EJECTCD configuration
@@ -194,58 +198,61 @@ variable.
 .TP
 .B \-X [cue2discid]
 Use an alternative "cue2discid" implementation. The name of the binary must be
-exactly that. abcde comes with an implementation in python under the examples
+exactly that. \fBabcde\fR comes with an implementation in python under the examples
 directory. The special keyword "builtin" forces the usage of the internal
 (default) implementation in shell script.
 .TP
 .B \-w [comment]
-Add a comment to the tracks ripped from the CD.
+Add a comment to the tracks ripped from the CD. If you wish to use
+parentheses, these will need to be escaped. i.e. you have to write
+"\\(" instead of "(".
 .TP
 .B \-W [number]
 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
-to modify the numbering of the tracks, starting with "#01". For Ogg/Vorbis and 
+to modify the numbering of the tracks, starting with "#01". For Ogg/Vorbis and
 FLAC files, it also defines a DISCNUMBER tag.
 .TP
 .B \-z
-DEBUG mode: it will rip, using cdparanoia, the very first second of each track
+DEBUG mode: it will rip, using \fBcdparanoia\fR, the very first second of each track
 and proceed with the actions requested very quickly, also providing some
 "hidden" information about what happens on the background. CAUTION: IT WILL
 ERASE ANY EXISTING RIPS WITHOUT WARNING!
 .TP
 .B [tracks]
-A list of tracks you want abcde to process. If this isn't specified, abcde
+A list of tracks you want \fBabcde\fR to process. If this isn't specified, \fBabcde\fR
 will process the entire CD. Accepts ranges of track numbers -
 "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
 .SH OUTPUT
-Each track is, by default, placed in a separate file named after the track
-in a subdirectory named after the artist under the current directory. 
-This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
-variables in your abcde.conf. Each file is given an extension identifying 
-its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.aac' or '.wav'.
+Each track is, by default, placed in a separate file named after the track in a
+subdirectory named after the artist under the current directory. This can be
+modified using the OUTPUTFORMAT and VAOUTPUTFORMAT variables in your
+\fIabcde.conf\fR. Each file is given an extension identifying  its compression
+format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.wav', 'wv', 'ape' or '.opus'.
 .SH CONFIGURATION
-abcde sources two configuration files on startup - /etc/abcde.conf and
-$HOME/.abcde.conf, in that order. 
-.TP
-The configuration options stated on those files can be overridden by providing
+\fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
+\fI$HOME/.abcde.conf\fR, in that order.
+.PP
+The configuration options stated in those files can be overridden by providing
 the appropriate flags at runtime.
-.TP
+.PP
 The configuration variables have to be set as follows:
 .TP
 .B VARIABLE=value
-Except when "value" needs to be quoted or otherwise interpreted. If other 
-variables within "value" are to be expanded upon reading the configuration 
-file, then double quotes should be used. If they are only supposed to be 
+Except when "value" needs to be quoted or otherwise interpreted. If other
+variables within "value" are to be expanded upon reading the configuration
+file, then double quotes should be used. If they are only supposed to be
 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
-.TP 
-All sh escaping/quoting rules apply.
 .TP
-Here is a list of options abcde recognizes:
+All shell escaping/quoting rules apply.
+.TP
+Here is a list of options \fBabcde\fR recognizes:
 .TP
 .B CDDBMETHOD
 Specifies the method we want to use to retrieve the track information. Two
 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
-Python to establish a conversation with the server for information retrieval.
+the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
+conversation with the Musicbrainz server for information retrieval.
 .TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.
@@ -262,14 +269,15 @@ connect. The format of this is username@hostname.
 .B CDDBLOCALDIR
 Specifies a directory where we store a local CDDB repository. The entries must
 be standard CDDB entries, with the filename being the DISCID value. Other
-CD playing and ripping programs (like Grip) store the entries under ~/.cddb
+CD playing and ripping programs (like Grip) store the entries under \fI~/.cddb\fR
 and we can make use of those entries.
 .TP
 .B CDDBLOCALRECURSIVE
 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
 is selected, it will be copied to the root of the CDDBLOCALDIR if
-CDDBLOCALPOLICY is "modified" or "new".
+CDDBLOCALPOLICY is "modified" or "new". The default "y" is needed for the local
+CDDB search to work.
 .TP
 .B CDDBLOCALPOLICY
 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
@@ -287,8 +295,8 @@ repository (if any). STILL NOT WORKING!!
 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
 .TP
 .B CDDBUSELOCAL
-Actually use the stored copies of the CDDB entries. Can be overridden using the 
-"\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give 
+Actually use the stored copies of the CDDB entries. Can be overridden using the
+"\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
 the choice of retrieving a CDDB entry from the internet.
 .TP
 .B SHOWCDDBFIELDS
@@ -296,7 +304,7 @@ Coma-separated list of fields we want to parse during the CDDB parsing.
 Defaults to "year,genre".
 .TP
 .B OGGENCODERSYNTAX
-Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options 
+Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
 This affects the default location of the binary,
 the variable to pick encoder command-line options from, and where the options
@@ -311,17 +319,41 @@ Affects the same way as explained above for Ogg/Vorbis.
 Specifies the style of encoder to use for the FLAC encoder. At this point only
 \'flac\' is available for FLAC encoding.
 .TP
+.B MP2ENCODERSYNTAX
+Specifies the style of encoder to use for the MPEG-1 Audio Layer II (MP2) encoder.
+At this point both \'twolame\' and \'ffmpeg\' are available for MP2 encoding.
+.TP
 .B SPEEXENCODERSYNTAX
 Specifies the style of encoder to use for Speex encoder. At this point only
 \'speexenc\' is available for Ogg/Speex encoding.
 .TP
-.B MPPENCODERSYNTAX
+.B MPCENCODERSYNTAX
 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
-point we only have \'mppenc\' available, from corecodecs.org.
+point we only have \'mpcenc\' available, from musepack.net.
 .TP
 .B AACENCODERSYNTAX
-Specifies the style of encoder to use for M4A (AAC) encoder. At this point we
-only support \'faac\', so \'default\' points to it.
+Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
+as \'default\' as well as higher quality audio with neroAacEnc, fdkaac, qaac,fhgaacenc
+and FFmpeg or avconv. If qaac, refalac or FFmpeg / avconv are used it is also possible
+to generate Apple Lossless Audio Codec (alac) files. Note that qaac, refalac and fhgaacenc
+are Windows applications which require Wine to be installed.
+.TP
+.B TTAENCODERSYNTAX
+Specifies the style of encoder to use for True Audio (tts) encoding. We
+support \'tta\' as default but the older \'ttaenc\' can be used as well.
+.TP
+.B WVENCODERSYNTAX
+Specifies the style of encoder to use for WavPack. We support \'wavpack\'
+as \'default\' but \'ffmpeg'\ is the other option (Note that this is for
+FFmpeg only as avconv does not have a native WavPack encoder).
+.TP
+.B APENCODERSYNTAX
+Specifies the style of encoder to use for Monkey's Audio (ape). We support \'mac\',
+Monkey's Audio Console, as \'default\'.
+.TP
+.B OPUSENCODERSYNTAX
+Specifies the style of encoder to use for the Opus encoder. At this point only
+\'opusenc\' is available for Opus encoding.
 .TP
 .B NORMALIZERSYNTAX
 Specifies the style of normalizer to use.  Valid options are \'default\'
@@ -330,9 +362,9 @@ ATM.
 .TP
 .B CDROMREADERSYNTAX
 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
-\'debug\' and \'flac\'. It is used for querying the CDROM and obtain a list of
-valid tracks and DATA tracks. The special \'flac\' case is used to "rip" CD
-tracks from a single-track flac file.
+\'libcdio'\, \'debug\' and \'flac\'. It is used for querying the CDROM and 
+obtain a list of valid tracks and DATA tracks. The special \'flac\' case is u
+sed to "rip" CD tracks from a single-track flac file.
 .TP
 .B CUEREADERSYNTAX
 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
@@ -345,7 +377,7 @@ behaviour with KEEPWAVS set is to keep the temporary directory and the wav
 files even you have requested the "clean" action.
 .TP
 .B PADTRACKS
-If set to "y", it adds 0's to the file numbers to complete a two-number 
+If set to "y", it adds 0's to the file numbers to complete a two-number
 holder. Useful when encoding tracks 1-9.
 .TP
 .B INTERACTIVE
@@ -354,24 +386,28 @@ Set to "n" if you want to perform automatic rips, without user intervention.
 .B NICE VALUES
 Define the values for priorities (nice values) for the different CPU-hungry
 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
-with distmp3 (DISTMP3NICE).
+with \fBdistmp3\fR (DISTMP3NICE).
 .TP
 .B PATHNAMES
 The following configuration file options specify the pathnames of their
-respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
-VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC,
-CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
-VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
-CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
+respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
+VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, WAVEPACK, APENC, OPUSENC, ID3, EYED3,
+METAFLAC, CDPARANOIA, CD_PARANOIA, CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, 
+EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, 
+MPCGAIN, MKCUE, MKTOC, CUE2DISCID (see option "\-X"), DIFF, HTTPGET, GLYRC,
+IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY, FFMPEG,
+TWOLAME, MID3V2, TTA and TTAENC.
 .TP
 .B COMMAND-LINE OPTIONS
-If you wish to specify command-line options to any of the programs abcde uses,
-set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
-BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS,
-FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS,
-CDPARANOIAOPTS, CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS,
-NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS, METAFLACOPTS,
-DIFFOPTS and HTTPGETOPTS.
+If you wish to specify command-line options to any of the programs \fBabcde\fR uses,
+set the following configuration file options: LAMEOPTS, GOGOOPTS,
+BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WAVEPACKENCOPTS, APENCOPTS,
+OGGENCOPTS, FLACOPTS, SPEEXENCOPTS, MPCENCOPTS, FAACENCOPTS, NEROAACENCOPTS, FDKAACENCOPTS, 
+OPUSENCOPTS, ID3OPTS, EYED3OPTS, MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS, PIRDOPTS, 
+CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, 
+VORBISCOMMMENTOPTS, METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS, HTTPGETOPTS,
+GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
+ATOMICPARSLEYOPTS, FFMPEGENCOPTS, TWOLAMENCOPTS and TTAENCOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -387,8 +423,8 @@ extraction. Abcde tries to guess the right device, but it may fail. The special
 \'flac\' option is defined to extract tracks from a single-track flac file.
 .TP
 .B CDPARANOIACDROMBUS
-Defined as "d" when using cdparanoia with an IDE bus and as "g" when using
-cdparanoia with the ide-scsi emulation layer.
+Defined as "d" when using \fBcdparanoia\fR with an IDE bus and as "g" when using
+\fBcdparanoia\fR with the ide-scsi emulation layer.
 .TP
 .B OUTPUTDIR
 Specifies the directory to place completed tracks/playlists in.
@@ -402,17 +438,18 @@ over 100MB for a machine that can encode music as fast as it can read it).
 Specifies the encoding format to output, as well as the default extension and
 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
-Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)), "m4a" (for M4A (AAC)) or
-"wav" (Microsoft Waveform). Values like "vorbis,mp3" encode the tracks in both
-Ogg/Vorbis and MP3 formats. For example
+Codec), "mp2" (MPEG-1 Audio Layer III), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack),
+"m4a" (AAC or ALAC),"wv" (WavPack"), "wav" (Microsoft Waveform), "opus"
+(Opus Interactive Audio Codec) or "tta" (True Audio). Values like "vorbis,mp3"
+encode the tracks in both Ogg/Vorbis and MP3 formats. For example:
 .br
 OUTPUTTYPE=vorbis,flac
 .br
-For each value in OUTPUTTYPE, abcde expands a different process for encoding,
-tagging and moving, so you can use the format placeholder, OUTPUT, to create 
+For each value in OUTPUTTYPE, \fBabcde\fR expands a different process for encoding,
+tagging and moving, so you can use the format placeholder, OUTPUT, to create
 different subdirectories to hold the different types. The variable OUTPUT will
-be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a' and/or 'wav', depending on the
-OUTPUTTYPE you define. For example
+be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape', 'tta' and/or 'wav',
+depending on the OUTPUTTYPE you define. For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
 .TP
@@ -420,19 +457,22 @@ OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
 (Musepack) or M4A filenames. Variables are included using standard shell
 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
-TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'. 
+TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
 Make sure to use single quotes around this variable. TRACKNUM is automatically
 zero-padded, when the number of encoded tracks is higher than 9. When lower,
 you can force with '\-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
-Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+Just like OUTPUTFORMAT but for Various Artists discs. The default is
+'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
 .TP
 .B ONETRACKOUTPUTFORMAT
-Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
+Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default
+is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B VAONETRACKOUTPUTFORMAT
-Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
+Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default
+is 'Various-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
@@ -485,14 +525,14 @@ syntax as OUTPUTFORMAT. Does not currently support ID3v2.
 .TP
 .B REMOTEHOSTS
 Specifies a comma-delimited list of systems to use for remote encoding using
-distmp3. Equivalent to \-r.
+\fBdistmp3\fR. Equivalent to \-r.
 .TP
 .B mungefilename
-mungefilename() is an abcde shell function that can be overridden via
-abcde.conf. It takes CDDB data as $1 and outputs the resulting filename on
-stdout. It defaults to eating control characters, apostrophes and
-question marks, translating spaces and forward slashes to underscores, and
-translating colons to an underscore and a hyphen.
+mungefilename() is an \fBabcde\fR shell function that can be overridden via
+\fIabcde.conf\fR. It takes CDDB data as $1 and outputs the resulting filename on
+stdout. It defaults to deleting any preceding dots to filename, replacing spaces
+with an underscore and eating characters which variously Windows and Linux do
+not permit.
 .br
 If you modify this function, it is probably a good idea to keep the forward
 slash munging (UNIX cannot store a file with a '/' char in it) as well as
@@ -506,7 +546,7 @@ to stdout converting all UPPERCASE characters to lowercase.
 .TP
 .B pre_read
 pre_read () is a shell function which is executed before the CDROM is read
-for the first time, during abcde execution. It can be used to close the CDROM
+for the first time, during \fBabcde\fR execution. It can be used to close the CDROM
 tray, to set its speed (via "setcd" or via "eject", if available) and other
 preparation actions. The default function is empty.
 .TP
@@ -517,22 +557,23 @@ from the CDROM, or to try to read the DATA areas from the CD (if any exist).
 The default function is empty.
 .TP
 .B EJECTCD
-If set to "y", abcde will call eject(1) to eject the cdrom from the drive
+If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
 after all tracks have been read. It has no effect when CDROM is set to a flac
 file.
 .TP
 .B EXTRAVERBOSE
-If set to "y", some operations which are usually now shown to the end user
+If set to "1", some operations which are usually now shown to the end user
 are visible, such as CDDB queries. Useful for initial debug and if your
-network/CDDB server is slow.
+network/CDDB server is slow. Set to "2" or more for even more verbose
+output.
 .SH EXAMPLES
-Possible ways one can call abcde
+Possible ways one can call \fBabcde\fR:
 .TP
 .B abcde
 Will work in most systems
 .TP
 .B abcde \-d /dev/cdrom2
-If the CDROM you are reading from is not the standard /dev/cdrom (in GNU/Linux systems)
+If the CDROM you are reading from is not the standard \fI/dev/cdrom\fR (in GNU/Linux systems)
 .TP
 .B abcde \-o vorbis,flac
 Will create both Ogg/Vorbis and Ogg/FLAC files.
@@ -546,25 +587,39 @@ For double+ CD settings: will create the 1st CD starting with the track number
 101, and will add a comment "CD 1" to the tracks, the second starting with 201
 and so on.
 .TP
-.B abcde \-d singletrack.flac
-Will extract the files contained in singletrack using the embedded cuesheet.
+.B abcde \-d singletrack.flac -o vorbis:"-q 6"
+Will extract the files contained in singletrack FLAC file using the embedded
+cuesheet and then encode the output files to Ogg/Vorbis with a quality setting of 6.
 .SH BACKEND TOOLS
-abcde requires the following backend tools to work:
+\fBabcde\fR requires the following backend tools to work:
 .TP
 .B *
-An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) or M4A encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc, faac)
+An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A encoder or Opus encoder 
+(oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc, faac, 
+neroAacEnc, fdkaac, wavpack, opusenc).
 .TP
 .B *
-An audio CD reading utility (cdparanoia, icedax, cdda2wav, dagrab)
+An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
+pird, dagrab). To read CD-TEXT information, icedax or cdda2wav will be needed.
 .TP
 .B *
 cd-discid, a CDDB DiscID reading program.
 .TP
 .B *
-An 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.
+An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X,
+among others). Alternatively, abcde-musicbrainz-tool (which depends on
+Perl and some Musicbrainz libraries) can be used to retrieve CDDB
+information about the CD.
+.TP
+.B *
+(for MP3s) id3 or eyeD3, id3 v1 and v2 tagging programs.
+.TP
+.B *
+For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
 .TP
 .B *
-(for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs.
+To retrieve album art a glyrc package is required and optionally the
+ImageMagick package should be installed.
 .TP
 .B *
 (optional) distmp3, a client/server for distributed mp3 encoding.
@@ -573,25 +628,34 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 (optional) normalize-audio, a WAV file volume normalizer.
 .TP
 .B *
-(optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, replaygain),
+(optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, mpcgain, wvgain),
 .TP
 .B *
 (optional) mkcue, a CD cuesheet extractor.
 .SH "SEE ALSO"
 .BR cdparanoia (1),
+.BR cd-paranoia (1)
 .BR icedax (1),
 .BR cdda2wav (1),
+.BR twolame (1),
+.BR mid3v2 (1),
+.BR pird (1),
 .BR dagrab (1),
 .BR normalize-audio (1),
 .BR oggenc (1),
 .BR vorbize (1),
 .BR flac (1),
-.BR toolame (1),
 .BR speexenc (1),
-.BR mppenc (1),
+.BR mpcenc (1),
 .BR faac (1),
+.BR fdkaac (1),
+.BR identify (1),
+.BR display (1),
+.BR convert (1),
+.BR wavpack (1),
+.BR wvgain (1),
 .BR id3 (1),
-.BR id3v2 (1),
+.BR eyeD3 (1),
 .BR wget (1),
 .BR fetch (1),
 .BR cd-discid (1),
@@ -603,4 +667,7 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 .BR mp3gain (1)
 .SH AUTHORS
 Robert Woodcock <rcw@debian.org>,
-Jesus Climent <jesus.climent@hispalinux.es> and contributions from many others.
+Jesus Climent <jesus.climent@hispalinux.es>,
+Colin Tuckley <colint@debian.org>,
+Steve McIntyre <93sam@debian.org>,
+Andrew Strong <andrew.david.strong@gmail.com> and contributions from many others.