partinfo: Fix usage message

[tools/e2fsprogs.git] / misc / badblocks.8.in

diff --git a/misc/badblocks.8.in b/misc/badblocks.8.in
index 78b8cb5..5a10f8a 100644 (file)
--- a/misc/badblocks.8.in
+++ b/misc/badblocks.8.in
@@ -16,6 +16,14 @@ badblocks \- search a device for bad blocks
 .I blocks_at_once
 ]
 [
+.B \-e
+.I max_bad_blocks
+]
+[
+.B \-d
+.I read_delay_factor
+]
+[
 .B \-i
 .I input_file
 ]
@@ -35,7 +43,7 @@ badblocks \- search a device for bad blocks
 [
 .I last-block
 ] [
-.I start-block 
+.I first-block 
 ]
 .SH DESCRIPTION
 .B badblocks
@@ -46,7 +54,7 @@ is the special file corresponding to the device (e.g
 .I last-block
 is the last block to be checked; if it is not specified, the last block
 on the device is used as a default.
-.I start-block
+.I first-block
 is an optional parameter specifying the starting block number
 for the test, which allows the testing to start in the middle of the
 disk.  If it is not specified the first block on the disk is used as a default.
@@ -81,11 +89,24 @@ Specify the size of blocks in bytes.  The default is 1024.
 .BI \-c " number of blocks"
 is the number of blocks which are tested at a time.  The default is 64.
 .TP
+.BI \-e " max bad block count"
+Specify a maximum number of bad blocks before aborting the test.  The
+default is 0, meaning the test will continue until the end of the test
+range is reached.
+.TP
+.BI \-d " read delay factor"
+This parameter, if passed and non-zero, will cause bad blocks to sleep
+between reads if there were no errors encountered in the read
+operation; the delay will be calculated as a percentage of the time it
+took for the read operation to be performed. In other words, a value of 
+100 will cause each read to be delayed by the amount the previous read
+took, and a value of 200 by twice the amount.
+.TP
 .B \-f
 Normally, badblocks will refuse to do a read/write or a non-destructive
 test on a device which is mounted, since either can cause the system to
 potentially crash and/or damage the filesystem even if it is mounted
-read-only.  This can be overriden using the
+read-only.  This can be overridden using the
 .B \-f
 flag, but should almost never be used --- if you think you're smarter
 than the 
@@ -136,7 +157,7 @@ may either be a numeric value between 0 and ULONG_MAX-1 inclusive, or the word
 "random", which specifies that the block should be filled with a random
 bit pattern.
 For read/write (\fB-w\fR) and non-destructive (\fB-n\fR) modes,
-one or more test patterns may be specified by specifiying the
+one or more test patterns may be specified by specifying the
 .B -t
 option for each test pattern desired.  For
 read-only mode only a single pattern may be specified and it may not be
@@ -144,7 +165,7 @@ read-only mode only a single pattern may be specified and it may not be
 specified pattern has previously been written to the disk - if not, large
 numbers of blocks will fail verification.  
 If multiple patterns
-are specified then all blocks will be tested with an one pattern 
+are specified then all blocks will be tested with one pattern 
 before proceeding to the next pattern.
 .TP
 .B \-n
@@ -168,14 +189,28 @@ every block of the device, reading every block and comparing the contents.
 This option may not be combined with the 
 .B \-n 
 option, as they are mutually exclusive.
+.TP
+.B \-X
+Internal flag only to be used by
+.BR e2fsck (8)
+and
+.BR mke2fs (8).
+It bypasses the exclusive mode in-use device safety check.
 .SH WARNING
 Never use the
 .B \-w
-option on an device containing an existing file system.
+option on a device containing an existing file system.
 This option erases data!  If you want to do write-mode testing on
 an existing file system, use the
 .B \-n
 option instead.  It is slower, but it will preserve your data.  
+.PP
+The
+.B \-e
+option will cause badblocks to output a possibly incomplete list of
+bad blocks. Therefore it is recommended to use it only when one wants
+to know if there are any bad blocks at all on the device, and not when
+the list of bad blocks is wanted.
 .SH AUTHOR
 .B badblocks
 was written by Remy Card <Remy.Card@linux.org>.  Current maintainer is