Added post_read().
[clinton/abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 6f5946a..2787b9d 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -1,4 +1,4 @@
-.TH ABCDE 1
+.TH abcde 1
 .SH NAME
 abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format.
 .SH SYNOPSIS
@@ -94,11 +94,15 @@ 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.
+.TP
 .B \-o [filetype][:filetypeoptions]
-Select output type. Can be "ogg", "mp3", "flac", "spx" or "mpc". 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
+Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx" or "mpc".
+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
@@ -112,9 +116,6 @@ the REMOTEHOSTS configuration variable.
 Add replaygain information to the id3 or tag information for play
 normalization. Only works with MP3 and Ogg/Vorbis.
 .TP
-.B \-s [number]
-[DEPRECATED: use -t, see below]
-.TP
 .B \-S [speed]
 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
 and both the program and device must support the capability.
@@ -154,11 +155,14 @@ 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 abcde.conf. Each file is given an extension identifying 
-its compression format, '.ogg', '.mp3', '.flac', '.spx', or '.mpc'.
+its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', or '.mpc'.
 .SH CONFIGURATION
 abcde sources two configuration files on startup - /etc/abcde.conf and
 $HOME/.abcde.conf, in that order. 
 .TP
+The configuration options stated on those files can ba overriden by providing
+the appropiate flags at runtime.
+.TP
 The configuration variables have to be set as follows:
 .TP
 .B VARIABLE=value
@@ -235,7 +239,7 @@ files even you have requested the "clean" action.
 .TP
 .B PADTRACKS
 If set to "y", it adds 0's to the file numbers to complete a two-number 
-holder. Usefull when encoding tracks 1-9.
+holder. Useful when encoding tracks 1-9.
 .TP
 .B INTERACTIVE
 Set to "n" if you want to perform automatic rips, without user intervention.
@@ -249,8 +253,8 @@ with distmp3 (DISTMP3NICE).
 The following configuration file options specify the pathnames of their
 respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC, VORBIZE,
 OGGENC, FLAC, SPEEXENC, MPPENC, ID3, ID3V2, CDPARANOIA, CDDA2WAV, CDDAFS,
-CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED
-and HTTPGET.
+CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED,
+VORBISGAIN, MKCUE and HTTPGET.
 .TP
 .B COMMAND-LINE OPTIONS
 If you wish to specify command-line options to any of the programs abcde
@@ -258,7 +262,7 @@ uses, set the following configuration file options: LAMEOPTS, GOGOOPTS,
 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS,
 FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, ID3OPTS, ID3V2OPTS, CDPARANOIAOPTS,
 CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS,
-CDSPEEDOPTS and HTTPGETOPTS.
+CDSPEEDOPTS, MKCUEOPTS,VORBISCOMMMENTOPTS, METAFLACOPTS and HTTPGETOPTS.
 .TP
 .B CDSPEEDVALUE
 Set the value of the CDROM speed. The default is to read the disc as fast as
@@ -282,15 +286,15 @@ over 100MB for a machine that can encode music as fast as it can read it).
 .TP
 .B OUTPUTTYPE
 Specifies the encoding format to output, as well as the default extension and
-encoder. Defaults to "ogg". Valid settings are "ogg" (Ogg/Vorbis), "mp3"
-(MPEG-1 Audio Layer III), "flac" (Free Lossless Audio Codec), "spx" (Ogg/Speex)
-and "mpc" (MPP/MP+ (Musepack)). Values like "ogg,mp3" encode the tracks in 
-both Ogg/Vorbis and MP3 formats.
+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) and "mpc" (MPP/MP+ (Musepack)). Values like
+"vorbis,mp3" encode the tracks in both Ogg/Vorbis and MP3 formats.
 .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 
 different subdirectories to hold the different types. The variable OUTPUT will
-be 'ogg', 'mp3', 'flac', 'spx' and/or 'mpc', depending on the OUTPUTTYPE you define.
+be 'vorbis', 'mp3', 'flac', 'spx' and/or 'mpc', depending on the OUTPUTTYPE you define.
 For example
 .br
 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
@@ -380,7 +384,7 @@ after all tracks have been read.
 .TP
 .B EXTRAVERBOSE
 If set to "y", some operations which are usually now shown to the end user
-are visible, such as CDDB queries. Usefull for initial debug and if your
+are visible, such as CDDB queries. Useful for initial debug and if your
 network/CDDB server is slow.
 .SH EXAMPLES
 Possible ways one can call abcdeƑ
@@ -391,10 +395,10 @@ Will work in most systems
 .B abcde -d /dev/cdrom2
 If the CDROM you are reding from is not the standard /dev/cdrom (in GNU/Linux systems)
 .TP
-.B abcde -o ogg,flac
+.B abcde -o vorbis,flac
 Will create both Ogg/Vorbis and Ogg/FLAC files.
 .TP
-.B abcde -o ogg:"-b 192"
+.B abcde -o vorbis:"-b 192"
 Will pass "-b 192" to the Ogg/Vorbis encoder, without having to modify the
 config file
 .TP