Add support for Musicbrainz using a perl helper script.

[clinton/abcde.git] / abcde.1

diff --git a/abcde.1 b/abcde.1
index 657eea0..706d601 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -52,16 +52,16 @@ can take a compressed backup of your CD collection.
 .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,
 .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.
+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, 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
 .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 normalize, replaygain and
-playlist.
+implies cddb. The default is to do all actions except cue, normalize,
+replaygain and playlist.

 .TP
 .B \-b
 Enable batch mode normalization. See the BATCHNORM configuration variable.
 .TP
 .B \-b
 Enable batch mode normalization. See the BATCHNORM configuration variable.


@@ -134,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
 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 (see option "\-d").
-.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
 .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


@@ -154,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
 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.
 .B \-r [hosts...]
 Remote encode on this comma-delimited list of machines using distmp3. See
 the REMOTEHOSTS configuration variable.


@@ -163,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...]
 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]
 Right now it only uses "year" and "genre".
 .TP
 .B \-S [speed]


@@ -204,7 +203,8 @@ 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
 .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
 .TP
 .B \-z
 DEBUG mode: it will rip, using cdparanoia, the very first second of each track


@@ -245,7 +245,8 @@ Here is a list of options abcde recognizes:
 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
 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

-Python to establish a conversation with the server for information retrieval.
+the Perl helper script abcde-musicbrainz-tool to establish a
+conversation with the Musicbrainz server for information retrieval.

 .TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.
 .TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.


@@ -288,7 +289,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 
 .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
 the choice of retrieving a CDDB entry from the internet.
 .TP
 .B SHOWCDDBFIELDS


@@ -340,7 +341,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,
 .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
 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
 files even you have requested the "clean" action.
 .TP


@@ -368,10 +369,10 @@ CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
 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,
 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,
 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
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as


@@ -404,7 +405,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), "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 
 .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 


@@ -421,8 +424,7 @@ 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,
 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. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
 .TP
 .B VAOUTPUTFORMAT
 Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'


@@ -445,6 +447,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.
 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
 .TP
 .B BATCHNORM
 If set to y, enables batch mode normalization, which preserves relative


@@ -479,7 +486,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
 .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
 .TP
 .B mungefilename
 mungefilename() is an abcde shell function that can be overridden via


@@ -532,7 +539,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 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
 config file
 .TP
 .B abcde \-W 1


@@ -549,7 +556,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 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.
 .TP
 .B *
 cd-discid, a CDDB DiscID reading program.


@@ -573,6 +580,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),
 (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),
 .BR cdda2wav (1),
 .BR dagrab (1),
 .BR normalize-audio (1),