Fix mp3 tagging fails for single author albums
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 43c2cfd..dd2c35d 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -39,19 +39,28 @@ Delete the intermediate WAV file (or save it for later use)
 .TP
 .B *
 Repeat until finished
+.P
+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
+treated as if it was the original CD. In a way,
+.B abcde
+can take a compressed backup of your CD collection.
 .SH OPTIONS
 .TP
 .B \-1
 Encode the whole CD in a single file. The resulting file uses the CD title
 for tagging. If the resulting format is a flac file with an embedded cuesheet,
-the file can be used as a source for creating other formats. Use "-1 -M -o
-flac" for obtaining such a file .TP
+the file can be used as a source for creating other formats. Use "\-1 \-o
+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, 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 normalize,
+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.
 .TP
 .B \-b
@@ -125,12 +134,6 @@ Non interactive mode. Do not ask anything from the user. Just go ahead.
 Create DOS-style playlists, modifying the resulting one by adding CRLF line
 endings. Some hardware players insist on having those to work.
 .TP
-.B \-M
-Create a CUE file with information about the CD. Together with the possibility
-of creating a single file (see option "\-1"), one can recreate the original CD.
-If the cuesheet is embedded in a flac single file it can be used as source for
-encoding other formats.
-.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
@@ -145,6 +148,11 @@ Pads track numbers with 0\'s.
 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).
+.TP
 .B \-r [hosts...]
 Remote encode on this comma-delimited list of machines using distmp3. See
 the REMOTEHOSTS configuration variable.
@@ -154,7 +162,7 @@ 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 comas, the fields to be shown in the CDDB parsed entries.
+List, separated by commas, the fields to be shown in the CDDB parsed entries.
 Right now it only uses "year" and "genre".
 .TP
 .B \-S [speed]
@@ -169,11 +177,9 @@ filenames and the playlist. Internal (tag) numbering remains the same.
 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
 .TP
-.B \-u
-Set CDDBPROTO to version 6, so that we retrieve UTF-8 encoded CDDB
-information, and we tag and add comments with a proper encoding. This flag will
-be removed and -U will be added to set it to version 5 once version 6 becomes
-the default.
+.B \-U
+Set CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
+information, and we tag and add comments with Latin1 encoding.
 .TP
 .B \-v
 Show the version and exit
@@ -186,12 +192,19 @@ sensation nothing is happening.
 Eject the CD when all tracks have been read. See the EJECTCD configuration
 variable.
 .TP
+.B \-X [cue2discid]
+Use an alternative "cue2discid" implementation. The name of the binary must be
+exactly that. abcde comes with an implementation in python under the examples
+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.
 .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".
+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
 DEBUG mode: it will rip, using cdparanoia, the very first second of each track
@@ -275,7 +288,7 @@ 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 
+"\-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
@@ -327,7 +340,7 @@ we only support \'mkcue\', but in the future other readers might be used.
 .TP
 .B KEEPWAVS
 It defaults to no, so if you want to keep those wavs ripped from your CD,
-set it to "y". You can use the "-k" switch in the command line. The default
+set it to "y". You can use the "\-k" switch in the command line. The default
 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
 files even you have requested the "clean" action.
 .TP
@@ -349,16 +362,16 @@ 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,
-DIFF and HTTPGET.
+CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
 .TP
 .B COMMAND-LINE OPTIONS
 If you wish to specify command-line options to any of the programs abcde uses,
 set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS,
-FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS,
+FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS, MP3GAINOPTS,
 CDPARANOIAOPTS, CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS,
 NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS, METAFLACOPTS,
-DIFFOPTS and HTTPGETOPTS.
+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
@@ -391,7 +404,9 @@ 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.
+Ogg/Vorbis and MP3 formats. For example
+.br
+OUTPUTTYPE=vorbis,flac
 .br
 For each value in OUTPUTTYPE, abcde expands a different process for encoding,
 tagging and moving, so you can use the format placeholder, OUTPUT, to create 
@@ -408,12 +423,16 @@ syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, 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.
+you can force with '\-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
-Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever
-OUTPUTFORMAT is set to.
+Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+.TP
+.B ONETRACKOUTPUTFORMAT
+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}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
@@ -427,6 +446,11 @@ reading them. This is substantially slower than normal operation but
 requires several hundred MB less space to complete the encoding of an
 entire CD. Use only if your system is low on space and cannot encode as
 quickly as it can read.
+
+Note that this option may also help when reading
+a CD with errors. This is because on a scratchy disk reading is quite timing
+sensitive and this option reduces the background load on the system which
+allows the ripping program more precise control.
 .TP
 .B BATCHNORM
 If set to y, enables batch mode normalization, which preserves relative
@@ -461,7 +485,7 @@ syntax as OUTPUTFORMAT. Does not currently support ID3v2.
 .TP
 .B REMOTEHOSTS
 Specifies a comma-delimited list of systems to use for remote encoding using
-distmp3. Equivalent to -r.
+distmp3. Equivalent to \-r.
 .TP
 .B mungefilename
 mungefilename() is an abcde shell function that can be overridden via
@@ -514,7 +538,7 @@ If the CDROM you are reading from is not the standard /dev/cdrom (in GNU/Linux s
 Will create both Ogg/Vorbis and Ogg/FLAC files.
 .TP
 .B abcde \-o vorbis:"-b 192"
-Will pass "-b 192" to the Ogg/Vorbis encoder, without having to modify the
+Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
 config file
 .TP
 .B abcde \-W 1
@@ -531,7 +555,7 @@ abcde requires the following backend tools to work:
 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) or M4A encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc, faac)
 .TP
 .B *
-An audio CD reading utility (cdparanoia, cdda2wav, dagrab)
+An audio CD reading utility (cdparanoia, icedax, cdda2wav, dagrab)
 .TP
 .B *
 cd-discid, a CDDB DiscID reading program.
@@ -555,6 +579,7 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 (optional) mkcue, a CD cuesheet extractor.
 .SH "SEE ALSO"
 .BR cdparanoia (1),
+.BR icedax (1),
 .BR cdda2wav (1),
 .BR dagrab (1),
 .BR normalize-audio (1),