r187@frost: data | 2005-10-06 15:41:10 +0300
[clinton/abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index c340f51..ece9eb7 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -36,7 +36,8 @@ Repeat until finished
 .TP
 .B \-1
 Encode the whole CD in a single file. The resulting file uses the CD title
-for tagging.
+for tagging. If the resulting format is a flac file with an embeded cuesheet,
+the file can be used as a source for creating other formats.
 .TP
 .B \-a [actions]
 Comma-delimited list of actions to perform. Can be one or more of:
@@ -46,7 +47,7 @@ cddb, read, encode, tag. Playlist implies cddb. The default is to
 do all actions except normalize and playlist.
 .TP
 .B \-b
-Enable batch mode normalization. See the BATCH configuration variable.
+Enable batch mode normalization. See the BATCHNORM configuration variable.
 .TP
 .B \-c [filename]
 Specifies an additional configuration file to parse. Configuration options
@@ -59,13 +60,23 @@ when you no longer have the CD available (abcde will automatically resume if
 you still have the CD in the drive). You must have already finished at
 least the "read" action during the previous session.
 .TP
-.B \-d [devicename]
-CD\-ROM block device that contains audio tracks to be read.
+.B \-d [devicename | filename]
+CD\-ROM block device that contains audio tracks to be read. Alternatively, a
+single-track flac file with embeded cuesheet.
 .TP
 .B \-D
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
 2>logfile')
 .TP
+.B \-e
+Erase information about encoded tracks from the internal status file, to enable
+other encodings if the wav files have been kept.
+.TP
+.B \-g
+Enable lame's \-\-nogap option.  See the NOGAP variable. WARNING: lame's
+\-\-nogap disables the Xing mp3 tag.  This tag is required for mp3 players to
+correctly display track lengths when playing variable-bit-rate mp3 files.
+.TP
 .B \-h
 Get help information.
 .TP
@@ -97,6 +108,8 @@ endings. Some hardware players insist on having those to work.
 .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 embeded 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" or "mpc".
@@ -114,7 +127,11 @@ the REMOTEHOSTS configuration variable.
 .TP
 .B \-R
 Add replaygain information to the id3 or tag information for play
-normalization. Only works with MP3 and Ogg/Vorbis.
+normalization. Only works with Ogg/FLAC and Ogg/Vorbis.
+.TP
+.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
@@ -197,6 +214,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,9 +248,14 @@ and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
 ATM.
 .TP
 .B CDROMREADERSYNTAX
-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.
+Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
+\'debug\' and \'flac\'. It is used for querying the CDROM and obtain a list of
+valid tracks and DATA tracks. The special \'flac\' case is used to "rip" CD
+tracks from a single-track flac file.
+.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,
@@ -274,7 +300,8 @@ The default actions to be performed when reading a disc.
 .TP
 .B CDROM
 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.
+extraction. Abcde tries to guess the right device, but it may fail. The special
+\'flac\' option is defined to extract tracks from a single-track flac file.
 .TP
 .B CDPARANOIACDROMBUS
 Defined as "d" when using cdparanoia with an IDE bus and as "g" when using
@@ -331,11 +358,18 @@ 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.
 .TP
-.B BATCH
+.B BATCHNORM
 If set to y, enables batch mode normalization, which preserves relative
 volume differences between tracks of an album. Also enables nogap encoding
 when using the \'lame\' encoder.
 .TP
+.B NOGAP
+Activate the lame's \-\-nogap option, that allows files found in CDs with no
+silence between songs (such as live concerts) to be encoded without noticeable
+gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag.  This tag is
+required for mp3 players to correctly display track lengths when playing
+variable-bit-rate mp3 files.
+.TP
 .B PLAYLISTFORMAT
 Specifies the format for completed playlist filenames. Works like the
 OUTPUTFORMAT configuration variable. Default is
@@ -382,33 +416,44 @@ 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.
+after all tracks have been read. It has no effect when CDROM is set to a flac
+file.
 .TP
 .B EXTRAVERBOSE
 If set to "y", some operations which are usually now shown to the end user
 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
 .TP
-.B abcde -d /dev/cdrom2
+.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 vorbis,flac
+.B abcde \-o vorbis,flac
 Will create both Ogg/Vorbis and Ogg/FLAC files.
 .TP
-.B abcde -o vorbis:"-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
-.B abcde -W 1
-For double CDs settings: will create the 1st CD starting with the track number
-101, and will add a comment "CD 1" to the tracks
+.B abcde \-W 1
+For double+ CD settings: will create the 1st CD starting with the track number
+101, and will add a comment "CD 1" to the tracks, the second starting with 201
+and so on.
+.TP
+.B abcde \-d singletrack.flac
+Will extract the files contained in singletrack using the embeded cuesheet.
 .SH BACKEND TOOLS
 abcde requires the following backend tools to work:
 .TP
@@ -432,6 +477,9 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 .TP
 .B *
 (optional) normalize, a WAV file volume normalizer.
+.TP
+.B *
+(optional) mkcue, a CD cuesheet extractor.
 .SH "SEE ALSO"
 .BR cdparanoia (1),
 .BR cdda2wav (1),
@@ -440,15 +488,16 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 .BR oggenc (1),
 .BR vorbize (1),
 .BR flac (1),
-.BR speexenc(1),
-.BR mppenc(1),
+.BR speexenc (1),
+.BR mppenc (1),
 .BR id3 (1),
 .BR wget (1),
 .BR fetch (1),
 .BR cd-discid (1),
 .BR distmp3 (1),
 .BR distmp3host (1),
-.BR curl(1)
+.BR curl (1)
+.BR mkcue (1),
 .SH AUTHORS
 Robert Woodcock <rcw@debian.org>,
 Jesus Climent <jesus.climent@hispalinux.es> and contributions from many others.