Encoding to True Audio (Part 3)
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 5b067d6..fd9ce13 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -1,7 +1,7 @@
 .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]
@@ -10,9 +10,9 @@ 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
+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 *
@@ -21,6 +21,10 @@ 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
 .TP
 .B *
@@ -28,7 +32,7 @@ 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), 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
@@ -62,11 +66,11 @@ 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.
@@ -107,6 +111,12 @@ 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
@@ -146,8 +156,9 @@ 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.
+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
@@ -308,6 +319,10 @@ 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.
@@ -318,11 +333,19 @@ 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.
+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\'.
+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\',
@@ -367,20 +390,24 @@ 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, 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, TWOLAMENCOPTS and TTAENCOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -411,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" (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) 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, \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' and/or 'wav',
+depending on the OUTPUTTYPE you define. For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
 .TP
@@ -435,13 +463,16 @@ 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
@@ -499,9 +530,9 @@ Specifies a comma-delimited list of systems to use for remote encoding using
 .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
@@ -556,8 +587,9 @@ 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
 \fBabcde\fR requires the following backend tools to work:
 .TP
@@ -586,6 +618,10 @@ information about the CD.
 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 *
@@ -601,17 +637,21 @@ For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
 .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),
@@ -629,4 +669,5 @@ For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
 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.