Remove broken debug print, whoops
[clinton/abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index ddab709..522254b 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -10,7 +10,7 @@ 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) or Opus format(s).
 With one command, it will:
 .TP
 .B *
@@ -23,7 +23,7 @@ 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 and/or Opus format(s), all in one CD read
 .TP
 .B *
 Comment or ID3/ID3v2 tag
@@ -123,6 +123,10 @@ Use the low-diskspace algorithm. See the LOWDISK configuration variable.
 .B \-L
 Use a local CDDB repository. See CDDBLOCALDIR variable.
 .TP
+.B \-m
+Create DOS-style playlists, modifying the resulting one by adding CRLF line
+endings. Some hardware players insist on having those to work.
+.TP
 .B \-n
 Do not query CDDB database. Create and use a template. Edit the template to
 provide song names, artist(s), ...
@@ -130,14 +134,10 @@ provide song names, artist(s), ...
 .B \-N
 Non interactive mode. Do not ask anything from the user. Just go ahead.
 .TP
-.B \-m
-Create DOS-style playlists, modifying the resulting one by adding CRLF line
-endings. Some hardware players insist on having those to work.
-.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
+"m4a", "wav" 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
@@ -157,10 +157,6 @@ are used in the config file(s).
 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".
@@ -185,8 +181,9 @@ information, and we tag and add comments with Latin1 encoding.
 Show the version and exit
 .TP
 .B \-V
-Be a bit more verbose. On slow networks the CDDB requests might give the
-sensation nothing is happening.
+Be more verbose. On slow networks the CDDB requests might give the
+sensation nothing is happening. Add this more than once to make things
+even more verbose.
 .TP
 .B \-x
 Eject the CD when all tracks have been read. See the EJECTCD configuration
@@ -217,11 +214,11 @@ 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', '.aac', '.wav' 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. 
@@ -316,13 +313,17 @@ 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\' but support is there for neroAacEnc as well.
+.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\'
@@ -360,8 +361,8 @@ 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,
+VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, AACENC, 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.
 .TP
@@ -369,10 +370,10 @@ CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
 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.
+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.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -403,9 +404,9 @@ 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" (for M4A (AAC))
+"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
@@ -523,9 +524,10 @@ after all tracks have been read. It has no effect when CDROM is set to a flac
 file.
 .TP
 .B EXTRAVERBOSE
-If set to "y", some operations which are usually now shown to the end user
+If set to "1", some operations which are usually now shown to the end user
 are visible, such as CDDB queries. Useful for initial debug and if your
-network/CDDB server is slow.
+network/CDDB server is slow. Set to "2" or more for even more verbose
+output.
 .SH EXAMPLES
 Possible ways one can call \fBabcde\fR:
 .TP
@@ -553,10 +555,10 @@ 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, opusenc).
 .TP
 .B *
-An audio CD reading utility (cdparanoia, icedax, cdda2wav, dagrab)
+An audio CD reading utility (cdparanoia, icedax, cdda2wav, pird, dagrab)
 .TP
 .B *
 cd-discid, a CDDB DiscID reading program.
@@ -568,7 +570,7 @@ 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 *
 (optional) distmp3, a client/server for distributed mp3 encoding.
@@ -585,6 +587,7 @@ information about the CD.
 .BR cdparanoia (1),
 .BR icedax (1),
 .BR cdda2wav (1),
+.BR pird (1),
 .BR dagrab (1),
 .BR normalize-audio (1),
 .BR oggenc (1),
@@ -592,10 +595,10 @@ information about the CD.
 .BR flac (1),
 .BR toolame (1),
 .BR speexenc (1),
-.BR mppenc (1),
+.BR mpcenc (1),
 .BR faac (1),
 .BR id3 (1),
-.BR id3v2 (1),
+.BR eyeD3 (1),
 .BR wget (1),
 .BR fetch (1),
 .BR cd-discid (1),