Doc rework

[clinton/abcde.git] / abcde.1

diff --git a/abcde.1 b/abcde.1
index 61b88b3..d97a78f 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -66,6 +66,10 @@ CD\-ROM block device that contains audio tracks to be read.
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
 2>logfile')
 .TP
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
 2>logfile')
 .TP

+.B \-f
+Force the use of a locally cached CDDB entry and fallback to a template if none
+is found. For faster network-disconnected operation.
+.TP

 .B \-j [number]
 Start [number] encoder processes at once. Useful for SMP systems. Overrides
 the MAXPROCS configuration variable. Set it to "0" when using distmp3 to avoid
 .B \-j [number]
 Start [number] encoder processes at once. Useful for SMP systems. Overrides
 the MAXPROCS configuration variable. Set it to "0" when using distmp3 to avoid


@@ -104,13 +108,20 @@ Remote encode on this comma-delimited list of machines using distmp3. See
 the REMOTEHOSTS configuration variable.
 .TP
 .B \-s [number]
 the REMOTEHOSTS configuration variable.
 .TP
 .B \-s [number]

-Start the numbering of the tracks at a given number. It only affects the
-filenames and the playlist. Internal (tag) numbering remains the same.
+[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.
 .TP
 .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.
 .TP

+.B \-t [number]
+Start the numbering of the tracks at a given number. It only affects the
+filenames and the playlist. Internal (tag) numbering remains the same.
+.TP
+.B \-T [number]
+Same as \-t but changes also the internal (tag) numbering. Keep in mind that
+the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
+.TP

 .B \-v
 Show the version and exit
 .TP
 .B \-v
 Show the version and exit
 .TP


@@ -180,7 +191,7 @@ point we only have \'mppenc\' available, from corecodecs.org.
 .TP
 .B NORMALIZERSYNTAX
 Specifies the style of normalizer to use.  Valid options are \'default\'
 .TP
 .B NORMALIZERSYNTAX
 Specifies the style of normalizer to use.  Valid options are \'default\'

-and \'normalize'\ (and both run \'normalize\'), since we only support it, ATM.
+and \'normalize'\ (and both run \'normalize-audio\'), since we only support it, ATM.

 .TP
 .B HELLOINFO
 Specifies the Hello information to send to the CDDB server. The CDDB
 .TP
 .B HELLOINFO
 Specifies the Hello information to send to the CDDB server. The CDDB


@@ -321,9 +332,25 @@ slash munging (UNIX cannot store a file with a '/' char in it) as well as
 the control character munging (NULs can't be in a filename either, and
 newlines and such in filenames are typically not desirable).
 .TP
 the control character munging (NULs can't be in a filename either, and
 newlines and such in filenames are typically not desirable).
 .TP

+.B mungegenre
+mungegenre () is a shell function used to modify the $GENRE variable. As
+a default action, it takes $GENRE as $1 and outputs the resulting value
+to stdout converting all UPPERCASE characters to lowercase.
+.TP
+.B pre_read
+pre_read () is a shell function which is executed before the CDROM is read
+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 EJECTCD
 If set to "y", abcde will call eject(1) to eject the cdrom from the drive
 after all tracks have been read.
 .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
+network/CDDB server is slow.

 .SH BACKEND TOOLS
 abcde requires the following backend tools to work:
 .TP
 .SH BACKEND TOOLS
 abcde requires the following backend tools to work:
 .TP


@@ -351,7 +378,7 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others
 .BR cdparanoia (1),
 .BR cdda2wav (1),
 .BR dagrab (1),
 .BR cdparanoia (1),
 .BR cdda2wav (1),
 .BR dagrab (1),

-.BR normalize (1),
+.BR normalize-audio (1),

 .BR oggenc (1),
 .BR vorbize (1),
 .BR flac (1),
 .BR oggenc (1),
 .BR vorbize (1),
 .BR flac (1),