Better handling of terminal length
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 80e1674..4d86b7e 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -1,7 +1,8 @@
 .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), True Audio (tta), MP2 format
+and/or AIFF (Audio Interchange File Format).
 .SH SYNOPSIS
 .B abcde
 .I [options] [tracks]
@@ -10,19 +11,20 @@ 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, True Audio (tta), MPEG Audio Layer II (MP2)
+or AIFF (Audio Interchange File Format) 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, or read CD-TEXT from your CD as a
-fallback for track information
+use a locally stored CDDB entry, or read CD-TEXT from your CD if it's available
 .TP
 .B *
 Download the album art appropriate for your music tracks with many
 user configurable options for download and post download alterations
+including automated embedding of the album art for some containers
 .TP
 .B *
 Grab an audio track (or all the audio CD tracks) from your CD
@@ -32,7 +34,8 @@ 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), True Audio (tta), MP2 or AIFF
+(Audio Interchange File Format) all in one CD read
 .TP
 .B *
 Comment or ID3/ID3v2 tag
@@ -66,15 +69,25 @@ 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, 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.
+read, getalbumart, embedalbumart, 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. embedalbumart implies getalbumart.
+The default is to do all actions except cue, normalize, replaygain, getalbumart,
+embedalbumart and playlist.
 .TP
 .B \-b
 Enable batch mode normalization. See the BATCHNORM configuration variable.
 .TP
+.B \-B
+Enable automatic embedding of album art with certain containers. As of
+abcde 2.8.2 supported containers are mp3 (using eyeD3), flac (using
+metaflac), m4a (using AtomicParsley), WavPack aka wv (using wvtag) and
+experimental support for ogg (using vorbiscomment). This command line
+option also calls the getalbumart function. Further details of album art
+embedding using the embedalbumart function can be found in the abcde FAQ
+document packaged with abcde.
+.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.
@@ -113,7 +126,7 @@ 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.
+CDDBMETHOD including 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
@@ -147,9 +160,9 @@ 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", "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
+"wav", "wv", "ape", "opus", "mka" or "aiff".  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
 .B \-p
@@ -227,7 +240,8 @@ 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'.
+format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.wav', '.wv',
+\(aq.ape', '.opus', '.mka' or 'aiff'.
 .SH CONFIGURATION
 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
 \fI$HOME/.abcde.conf\fR, in that order.
@@ -248,11 +262,15 @@ All shell escaping/quoting rules apply.
 Here is a list of options \fBabcde\fR recognizes:
 .TP
 .B CDDBMETHOD
-Specifies the method we want to use to retrieve the track information. Two
-values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
-CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
-the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
-conversation with the Musicbrainz server for information retrieval.
+Specifies the methods we want to use to retrieve the track
+information. Three values are recognized: "cddb", "musicbrainz" and
+"cdtext". List all the methods desired in a comma delimited list and
+\fBabcde\fR will attempt them all, returning a list of all search
+results. The "cddb" value needs the CDDBURL and HELLOINFO variables
+described below. The "musicbrainz" value uses the Perl helper script
+\fBabcde-musicbrainz-tool\fR to establish a conversation with the
+Musicbrainz server for information retrieval. "cdtext" needs "icedax"
+or "cdda2wav" to be installed.
 .TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.
@@ -319,6 +337,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 both \'twolame\' and \'ffmpeg\' are 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.
@@ -328,14 +350,20 @@ Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
 point we only have \'mpcenc\' available, from musepack.net.
 .TP
 .B AACENCODERSYNTAX
-Specifies the style of encoder to use for M4A (AAC) encoder. We support \'faac\'
-as \'default\' as well as higher quality audio with neroAacEnc, fdkaac and qaac.
-If qaac is used it is also possible to generate Apple Lossless Audio Codec (alac)
-files. Note that qaac is a Windows application which requires Wine to be installed.
+Specifies the style of encoder to use for M4A (AAC) encoder. We support \'fdkaac\'
+as \'default\' as well as FFmpeg or avconv, neroAacEnc, qaac and fhgaacenc. If qaac,
+refalac or FFmpeg / avconv are used it is also possible to generate Apple Lossless
+Audio Codec (alac) files. Note that qaac, refalac and fhgaacenc are Windows applications
+which require Wine to be installed.
+.TP
+.B TTAENCODERSYNTAX
+Specifies the style of encoder to use for True Audio (tts) encoding. We
+support \'tta\' as default but the older \'ttaenc\' can be used as well.
 .TP
 .B WVENCODERSYNTAX
 Specifies the style of encoder to use for WavPack. We support \'wavpack\'
-as \'default\'.
+as \'default\' but \'ffmpeg'\ is the other option (Note that this is for
+FFmpeg only as avconv does not have a native WavPack encoder).
 .TP
 .B APENCODERSYNTAX
 Specifies the style of encoder to use for Monkey's Audio (ape). We support \'mac\',
@@ -345,6 +373,16 @@ Monkey's Audio Console, as \'default\'.
 Specifies the style of encoder to use for the Opus encoder. At this point only
 \'opusenc\' is available for Opus encoding.
 .TP
+.B MKAENCODERSYNTAX
+Specifies the style of encoder to use for the Matroska or mka container. At this
+point only \'ffmpeg\' is available to utilise the mka container. Safe audio codecs
+for mka include Vorbis, MP2, MP3, LC-AAC, HE-AAC, WMAv1, WMAv2, AC3, eAC3 and Opus.
+See the FAQ document for more information.
+.TP
+.B AIFFENCODERSYNTAX
+Specifies the style of encoder to use for Audio Interchange File Format (AIFF). 
+At this point only \'ffmpeg\' is available to utilise the AIFF container. 
+.TP
 .B NORMALIZERSYNTAX
 Specifies the style of normalizer to use.  Valid options are \'default\'
 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
@@ -380,22 +418,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,
-VORBIZE, OGGENC, FLAC, SPEEXENC, MPCENC, WVENC, APENC, OPUSENC, ID3, EYED3,
+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 and WINE.
+IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE, FHGAACENC, ATOMICPARSLEY, FFMPEG,
+TWOLAME, MID3V2, TTA and TTAENC.
 .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,
+set the following configuration file options: LAMEOPTS, GOGOOPTS, AIFFENCOPTS,
+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 and QAACENCOPTS.
+GLYRCOPTS, IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS, QAACENCOPTS, FHGAACENCOPTS,
+ATOMICPARSLEYOPTS, FFMPEGENCOPTS, DAGRABOPTS, TWOLAMENCOPTS and TTAENCOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -426,17 +466,19 @@ 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)),
-"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), "opus"
+(Opus Interactive Audio Codec), "tta" (True Audio), "mka" (Matroska) or
+"aiff" (Audio Interchange File Format). 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
-OUTPUTTYPE you define. For example
+be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a', mp2, 'wv', 'ape', 'tta', 'wav', 
+'mka' and/or 'aiff' depending on the OUTPUTTYPE you define. For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
 .TP
@@ -450,13 +492,16 @@ zero-padded, when the number of encoded tracks is higher than 9. When lower,
 you can force with '\-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
-Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+Just like OUTPUTFORMAT but for Various Artists discs. The default is
+\(aqVarious-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
 .TP
 .B ONETRACKOUTPUTFORMAT
-Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
+Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default
+is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B VAONETRACKOUTPUTFORMAT
-Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
+Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default
+is 'Various-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
@@ -522,6 +567,10 @@ If you modify this function, it is probably a good idea to keep the forward
 slash munging (UNIX cannot store a file with a '/' char in it) as well as
 the control character munging (NULs can't be in a filename either, and
 newlines and such in filenames are typically not desirable).
+.br
+New to abcde 2.7.3 are the user definable functions mungetrackname, mungeartistname
+and mungealbumname which default to mungefilename. These permit finer-grained
+control of track name, artist name and album name for the ultra-fastidious.
 .TP
 .B mungegenre
 mungegenre () is a shell function used to modify the $GENRE variable. As
@@ -540,6 +589,13 @@ post_read () is a shell function which is executed after the CDROM is read
 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
 The default function is empty.
 .TP
+.B post_encode
+post_encode () is a shell function which is executed after the encoding process.
+It can be used to move completed files to another location, run any sort of testing
+on the completed files or embed album art if the built in embedding provided by
+abcde's embedalbumart function is not to your taste.
+The default function is empty.
+.TP
 .B EJECTCD
 If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
 after all tracks have been read. It has no effect when CDROM is set to a flac
@@ -566,6 +622,10 @@ Will create both Ogg/Vorbis and Ogg/FLAC files.
 Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
 config file
 .TP
+.B abcde \-o mp3,flac,m4a,wv,ogg -B
+abcde will create mp3, flac, m4a, wv and ogg files and also select
+suitable album art, download and embed the album art into all 5 sets of tracks.
+.TP
 .B abcde \-W 1
 For double+ CD settings: will create the 1st CD starting with the track number
 101, and will add a comment "CD 1" to the tracks, the second starting with 201
@@ -579,8 +639,8 @@ cuesheet and then encode the output files to Ogg/Vorbis with a quality setting o
 .TP
 .B *
 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).
+(oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mpcenc,
+fdkaac, neroAacEnc, faac, wavpack, opusenc).
 .TP
 .B *
 An audio CD reading utility (cdparanoia, icedax, cdda2wav, libcdio (cd-paranoia),
@@ -621,13 +681,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),
@@ -637,6 +698,7 @@ ImageMagick package should be installed.
 .BR convert (1),
 .BR wavpack (1),
 .BR wvgain (1),
+.BR wvtag (1),
 .BR id3 (1),
 .BR eyeD3 (1),
 .BR wget (1),