Badge the upcoming release as 2.7 rather than 2.6.1
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index e8ec39e..cfa2923 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 and/or MPP/MP+(Musepack) format.
+WavPack, Monkey's Audio (ape) and/or MPP/MP+(Musepack) format.
 .SH SYNOPSIS
 .B abcde
 .I [options] [tracks]
@@ -11,8 +11,8 @@ 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), M4A (AAC) wv (WavPack) 
-or Opus format(s).
+Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack), M4A (AAC) wv (WavPack), 
+Monkey's Audio (ape) or Opus format(s).
 With one command, it will:
 .TP
 .B *
@@ -21,14 +21,18 @@ 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 *
 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) 
-and/or Opus 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) and/or Opus format(s), 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
@@ -136,8 +146,8 @@ provide song names, artist(s), ...
 Non interactive mode. Do not ask anything from the user. Just go ahead.
 .TP
 .B \-o [filetype][:filetypeoptions]
-Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
-"m4a", "wav", "wv" or "opus".  Specify a comma-delimited list of output types to obtain
+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.
@@ -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
@@ -216,7 +227,7 @@ 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' or '.opus'.
+format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.wav', 'wv', 'ape' or '.opus'.
 .SH CONFIGURATION
 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
 \fI$HOME/.abcde.conf\fR, in that order.
@@ -265,7 +276,8 @@ and we can make use of those entries.
 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
@@ -323,6 +335,10 @@ as \'default\' as well as higher quality audio with neroAacEnc and fdkaac.
 Specifies the style of encoder to use for WavPack. We support \'wavpack\'
 as \'default\'.
 .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.
@@ -334,9 +350,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
@@ -363,19 +379,21 @@ with \fBdistmp3\fR (DISTMP3NICE).
 .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, OPUSENC, ID3, EYED3, METAFLAC,
-CDPARANOIA, CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
-VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
-CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
+VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, AACENC, WVENC, 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 and CONVERT.
 .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, OGGENCOPTS,
-FLACOPTS, SPEEXENCOPTS, MPCENCOPTS, AACENCOPTS, OPUSENCOPTS, ID3OPTS, EYED3OPTS,
-MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS, PIRDOPTS, CDDAFSOPTS, CDDBTOOLOPTS,
-EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS,
-METAFLACOPTS, DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS and HTTPGETOPTS.
+BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, WVENCOPTS, 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 and DISPLAYCMDOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -415,7 +433,7 @@ OUTPUTTYPE=vorbis,flac
 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' and/or 'wav', depending on the
+be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', 'wv', 'ape' and/or 'wav', depending on the
 OUTPUTTYPE you define. For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
@@ -562,9 +580,8 @@ An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack), M4A encoder or Opus enco
 neroAacEnc, fdkaac, wavpack, opusenc).
 .TP
 .B *
-An audio CD reading utility (cdparanoia, icedax, cdda2wav, pird,
-dagrab). To read CD-TEXT information, icedax or cdda2wav will be
-needed.
+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.
@@ -579,18 +596,26 @@ information about the CD.
 (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 *
+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 *
 (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 pird (1),
@@ -604,7 +629,11 @@ information about the CD.
 .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 eyeD3 (1),
 .BR wget (1),