.TH abcde 1
.SH NAME
abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, AAC,
-WavPack, Monkey's Audio (ape) and/or MPP/MP+(Musepack) format.
+WavPack, Monkey's Audio (ape), MPP/MP+(Musepack), True Audio (tta) and/or MP2 format.
.SH SYNOPSIS
.B abcde
.I [options] [tracks]
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
+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) or Opus format(s).
+Monkey's Audio (ape), Opus, True Audio (tta) or MPEG Audio Layer II (MP2) format(s).
With one command, it will:
.TP
.B *
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
.TP
.B *
.TP
.B *
Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A, wv (WavPack),
-Monkey's Audio (ape) and/or Opus format(s), all in one CD read
+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
.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.
\-\-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
.TP
.B \-o [filetype][:filetypeoptions]
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
+"wav", "wv", "ape", "opus" or "mka". 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
.B \-p
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.
+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 \fBdistmp3\fR. See
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'.
+format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.wav', '.wv',
+\(aq.ape', '.opus' or '.mka'.
.SH CONFIGURATION
\fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
\fI$HOME/.abcde.conf\fR, in that order.
.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
-the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
-conversation with the Musicbrainz server for information retrieval.
+values are recognized: "cddb" and/or "musicbrainz" which can be given as
+a comma delimited list to be tried sequentially in the event of failure
+of the first search. The "cddb" value needs the CDDBURL and HELLOINFO
+variables described below. The "musicbrainz" value uses 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.
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.
point we only have \'mpcenc\' available, from musepack.net.
.TP
.B AACENCODERSYNTAX
-Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
-as \'default\' as well as higher quality audio with neroAacEnc and fdkaac.
+Specifies the style of encoder to use for M4A (AAC) encoder. We support \'fdkaac\'
+as \'default\' as well as FFmpeg or avconv, neroAacEnc, qaac and fhgaacenc. 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\'.
+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\',
Specifies the style of encoder to use for the Opus encoder. At this point only
\'opusenc\' is available for Opus encoding.
.TP
+.B MKAENCODERSYNTAX
+Specifies the style of encoder to use for the Matroska or mka container. At this
+point only \'ffmpeg\' is available to utilise the mka container. Safe audio codecs
+for mka include Vorbis, MP2, MP3, LC-AAC, HE-AAC, WMAv1, WMAv2, AC3, eAC3 and Opus.
+See the FAQ document for more information.
+.TP
.B NORMALIZERSYNTAX
Specifies the style of normalizer to use. Valid options are \'default\'
and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
.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, MPCENC, AACENC, WVENC, APENC, OPUSENC, ID3, EYED3,
+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 and HTTPGET.
+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 \fBabcde\fR uses,
-set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
-BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WVENCOPTS, APENCOPTS,
+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 and HTTPGETOPTS.
+VORBISCOMMMENTOPTS, METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS, HTTPGETOPTS,
+GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
+ATOMICPARSLEYOPTS, FFMPEGENCOPTS, DAGRABOPTS, TWOLAMENCOPTS and TTAENCOPTS.
.TP
.B CDSPEEDVALUE
Set the value of the CDROM speed. The default is to read the disc as fast as
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" (AAC)),
-"wv" (WavPack", "wav" (Microsoft Waveform) or "opus" (Opus Interactive Audio Codec). 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), "tta" (True Audio) or "mka" (Matroska). 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, \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', 'wv', 'ape' and/or 'wav', depending on the
-OUTPUTTYPE you define. For example
+be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape', 'tta', 'wav'
+and/or 'mka' depending on the OUTPUTTYPE you define. For example
.br
OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
.TP
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
+\(aqVarious-${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
.B mungefilename
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 eating control characters, apostrophes and
-question marks, translating spaces and forward slashes to underscores, and
-translating colons to an underscore and a hyphen.
+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
the control character munging (NULs can't be in a filename either, and
newlines and such in filenames are typically not desirable).
+.br
+New to abcde 2.7.3 are the user definable functions mungetrackname, mungeartistname
+and mungealbumname which default to mungefilename. These permit finer-grained
+control of track name, artist name and album name for the ultra-fastidious.
.TP
.B mungegenre
mungegenre () is a shell function used to modify the $GENRE variable. As
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
\fBabcde\fR requires the following backend tools to work:
.TP
.B *
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).
+(oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc,
+fdkaac, neroAacEnc, faac, wavpack, opusenc).
.TP
.B *
An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
.TP
.B *
+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.
.TP
.B *
.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 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),
Robert Woodcock <rcw@debian.org>,
Jesus Climent <jesus.climent@hispalinux.es>,
Colin Tuckley <colint@debian.org>,
-Steve McIntyre <93sam@debian.org> and contributions from many others.
+Steve McIntyre <93sam@debian.org>,
+Andrew Strong <andrew.david.strong@gmail.com> and contributions from many others.