r174@frost: data | 2005-10-02 15:29:31 +0300

[clinton/abcde.git] / abcde.1

diff --git a/abcde.1 b/abcde.1
index 85831f3..73a26ed 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
 .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:
 .TP
 .B \-a [actions]
 Comma-delimited list of actions to perform. Can be one or more of:


@@ -59,8 +60,9 @@ 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
 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
 .TP
 .B \-D
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D


@@ -97,6 +99,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.
 .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".
 .TP
 .B \-o [filetype][:filetypeoptions]
 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx" or "mpc".


@@ -114,7 +118,7 @@ the REMOTEHOSTS configuration variable.
 .TP
 .B \-R
 Add replaygain information to the id3 or tag information for play
 .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.
 .TP
 .B \-s [fields...]
 List, separated by comas, the fields to be shown in the CDDB parsed entries.


@@ -235,9 +239,10 @@ and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
 ATM.
 .TP
 .B CDROMREADERSYNTAX
 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
 .TP
 .B CUEREADERSYNTAX
 Specifies the syntax of the program we use to read the CD CUE sheet. Right now


@@ -286,7 +291,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
 .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
 .TP
 .B CDPARANOIACDROMBUS
 Defined as "d" when using cdparanoia with an IDE bus and as "g" when using


@@ -402,7 +408,8 @@ The default function is empty.
 .TP
 .B EJECTCD
 If set to "y", abcde will call eject(1) to eject the cdrom from the drive
 .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
 .TP
 .B EXTRAVERBOSE
 If set to "y", some operations which are usually now shown to the end user


@@ -425,8 +432,12 @@ 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

-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
+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
 .SH BACKEND TOOLS
 abcde requires the following backend tools to work:
 .TP


@@ -450,6 +461,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) normalize, a WAV file volume normalizer.

+.TP
+.B *
+(optional) mkcue, a CD cuesheet extractor.

 .SH "SEE ALSO"
 .BR cdparanoia (1),
 .BR cdda2wav (1),
 .SH "SEE ALSO"
 .BR cdparanoia (1),
 .BR cdda2wav (1),


@@ -458,15 +472,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 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 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.
 .SH AUTHORS
 Robert Woodcock <rcw@debian.org>,
 Jesus Climent <jesus.climent@hispalinux.es> and contributions from many others.