In manpage note a 2nd use for LOWDISK (or '-l' switch)

[clinton/abcde.git] / abcde.1

diff --git a/abcde.1 b/abcde.1
index 17b481e..dbdcf64 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -52,8 +52,8 @@ 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,
-the file can be used as a source for creating other formats. Use "-1 -o
-flac -a default,cue" 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,
@@ -162,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]
@@ -203,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
-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
@@ -287,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
@@ -339,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
@@ -403,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 
@@ -420,8 +423,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,
-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}'
@@ -444,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
@@ -478,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
@@ -531,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
@@ -548,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.
@@ -572,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),