r168@frost: data | 2005-09-19 10:27:33 +0300
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 95f67e1..85831f3 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -94,6 +94,10 @@ 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 "vorbis" (or "ogg"), "mp3", "flac", "spx" or "mpc".
 Specify a comma-delimited list of output types to obtain all specified types.
@@ -112,8 +116,9 @@ 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]
+.B \-s [fields...]
+List, separated by comas, the fields to be shown in the CDDB parsed entries.
+Right now it only uses "year" and "genre".
 .TP
 .B \-S [speed]
 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
@@ -159,6 +164,9 @@ its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', or '.mpc'.
 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
@@ -193,6 +201,10 @@ Actually use the stored copies of the CDDB entries. Can be overriden using the
 "-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
+Coma-separated list of fields we want to parse during the CDDB parsing.
+Defaults to "year,genre".
+.TP
 .B OGGENCODERSYNTAX
 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options 
 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
@@ -227,6 +239,10 @@ Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\'
 and \'debug\'. It is used for querying the CDROM and obtain a list of valid
 tracks and DATA tracks. Right now, only cdparanoia is supported.
 .TP
+.B CUEREADERSYNTAX
+Specifies the syntax of the program we use to read the CD CUE sheet. Right now
+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
@@ -235,7 +251,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 +265,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 +274,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
@@ -272,6 +288,10 @@ The default actions to be performed when reading a disc.
 If set, it points to the CD-Rom device which has to be used for audio
 extraction. Abcde tries to guess the right device, but it may fail.
 .TP
+.B CDPARANOIACDROMBUS
+Defined as "d" when using cdparanoia with an IDE bus and as "g" when using
+cdparanoia with the ide-scsi emulation layer.
+.TP
 .B OUTPUTDIR
 Specifies the directory to place completed tracks/playlists in.
 .TP
@@ -374,16 +394,22 @@ for the first time, during abcde execution. It can be used to close the CDROM
 tray, to set its speed (via "setcd" or via "eject", if available) and other
 preparation actions. The default function is empty.
 .TP
+.B post_read
+post_read () is a shell function which is executed after the CDROM is read
+(and, if applies, before the CDROM is ejected). It can be used to read a TOC
+from the CDROM, or to try to read the DATA areas from the CD (if any exist).
+The default function is empty.
+.TP
 .B EJECTCD
 If set to "y", abcde will call eject(1) to eject the cdrom from the drive
 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Ñ
+Possible ways one can call abcde
 .TP
 .B abcde
 Will work in most systems