Support added for MPEG-1 Audio Layer II (mp2) encoding
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 3c1f264..badd0d7 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) 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 or MPEG Audio Layer II (MP2) format(s).
 With one command, it will:
 .TP
 .B *
@@ -32,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) and/or MP2, all in one CD read
 .TP
 .B *
 Comment or ID3/ID3v2 tag
@@ -319,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 only \'twolame\' is 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.
@@ -382,23 +386,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,
+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, HTTPGET, GLYRC,
-IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY and FFMPEG.
+IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY, FFMPEG,
+TWOLAME and MID3V2.
 .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,
+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, HTTPGETOPTS,
 GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
-ATOMICPARSLEYOPTS and FFMPEGENCOPTS.
+ATOMICPARSLEYOPTS, FFMPEGENCOPTS and TWOLAMENCOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -429,16 +434,17 @@ 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 or ALAC),
-"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) 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
 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
+be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape' and/or 'wav', depending on the
 OUTPUTTYPE you define. For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
@@ -624,13 +630,14 @@ ImageMagick package should be installed.
 .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),