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 7cef174..cfa2923 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -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 *
@@ -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
@@ -339,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
@@ -369,18 +380,20 @@ with \fBdistmp3\fR (DISTMP3NICE).
 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,
-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.
+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, APENCOPTS,
-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.
+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
@@ -567,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.
@@ -587,6 +599,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 *
@@ -599,6 +615,7 @@ For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
 (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),
@@ -612,6 +629,9 @@ For Monkey's Audio (ape) tagging Robert Muth's 'apetag' is required.
 .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),