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 b20855f..cfa2923 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) and/or MPP/MP+(Musepack) format.
 .SH SYNOPSIS
 .B abcde
 .I [options] [tracks]
@@ -10,11 +11,18 @@ 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).
+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 *
-Do a CDDB or Musicbrainz 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) and/or Opus format(s), 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,19 +66,15 @@ 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 \fI/etc/abcde.conf\fR or \fI$HOME/.abcde.conf\fR.
@@ -106,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
@@ -135,9 +146,9 @@ 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" 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 \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".
@@ -200,11 +203,13 @@ 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
@@ -218,14 +223,14 @@ A list of tracks you want \fBabcde\fR to process. If this isn't specified, \fBab
 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 \fIabcde.conf\fR. 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
 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
-\fI$HOME/.abcde.conf\fR, in that order. 
+\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.
@@ -233,11 +238,11 @@ the appropriate flags at runtime.
 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 
+.TP
 All shell escaping/quoting rules apply.
 .TP
 Here is a list of options \fBabcde\fR recognizes:
@@ -271,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
@@ -289,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
@@ -298,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
@@ -317,13 +323,25 @@ Specifies the style of encoder to use for the FLAC encoder. At this point only
 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 and fdkaac.
+.TP
+.B WVENCODERSYNTAX
+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.
 .TP
 .B NORMALIZERSYNTAX
 Specifies the style of normalizer to use.  Valid options are \'default\'
@@ -332,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
@@ -347,7 +365,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
@@ -361,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, 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.
+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, OGGENCOPTS,
-FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS, MP3GAINOPTS,
-CDPARANOIAOPTS, CDDA2WAVOPTS, 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
@@ -404,16 +424,16 @@ 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), "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
 .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 
+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
+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}'
@@ -422,7 +442,7 @@ 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.
@@ -555,10 +575,13 @@ Will extract the files contained in singletrack using the embedded cuesheet.
 \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.
@@ -570,7 +593,14 @@ Perl and some Musicbrainz libraries) can be used to retrieve CDDB
 information about the CD.
 .TP
 .B *
-(for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs.
+(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.
@@ -579,14 +609,16 @@ information about the CD.
 (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),
 .BR dagrab (1),
 .BR normalize-audio (1),
 .BR oggenc (1),
@@ -594,10 +626,16 @@ information about the CD.
 .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),