e2fsck: track errors/badness found for each inode

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

diff --git a/misc/fsck.8.in b/misc/fsck.8.in
index 5963562..50fd8ce 100644 (file)
--- a/misc/fsck.8.in
+++ b/misc/fsck.8.in
@@ -8,7 +8,13 @@ fsck \- check and repair a Linux file system
 .SH SYNOPSIS
 .B fsck
 [
-.B \-sACVRTNP
+.B \-sAVRTMNP
+]
+[
+.B \-C
+[
+.I fd
+]
 ]
 [
 .B \-t
@@ -30,8 +36,9 @@ or an ext2 label or UUID specifier (e.g.
 UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd or LABEL=root).  
 Normally, the 
 .B fsck 
-program will try to run filesystems on different physical disk drives 
-in parallel to reduce total amount time to check all of the filesystems.
+program will try to handle filesystems on different physical disk drives 
+in parallel to reduce the total amount of time needed to check all of the
+filesystems.
 .PP
 If no filesystems are specified on the command line, and the 
 .B \-A 
@@ -39,7 +46,7 @@ option is not specified,
 .B fsck
 will default to checking filesystems in
 .B /etc/fstab
-serial.  This is equivalent to the 
+serially.  This is equivalent to the 
 .B \-As
 options.
 .PP
@@ -121,7 +128,7 @@ in
 .I fslist
 will be checked.
 .sp
-Options specifiers may be included in the comma separated
+Options specifiers may be included in the comma-separated
 .IR fslist .
 They must have the format 
 .BI opts= fs-option\fR.
@@ -179,7 +186,7 @@ Walk through the
 file and try to check all file systems in one run.  This option is
 typically used from the
 .I /etc/rc
-system initalization file, instead of multiple commands for checking
+system initialization file, instead of multiple commands for checking
 a single file system.
 .sp
 The root filesystem will be checked first unless the
@@ -207,7 +214,7 @@ Hence, a very common configuration in
 files is to set the root filesystem to have a 
 .I fs_passno
 value of 1
-and to set all filesystems to have a
+and to set all other filesystems to have a
 .I fs_passno
 value of 2.  This will allow
 .B fsck
@@ -218,10 +225,17 @@ checks running in parallel for some reason --- for example, if the
 machine in question is short on memory so that
 excessive paging is a concern.
 .TP
-.B \-C
-Display completion/progress bars for those filesystems checkers (currently
-only for ext2) which support them.   Fsck will manage the filesystem checkers
-so that only one of them will display a progress bar at a time.
+.B \-C\fR [ \fI "fd" \fR ]
+Display completion/progress bars for those filesystem checkers (currently 
+only for ext2 and ext3) which support them.   Fsck will manage the
+filesystem checkers so that only one of them will display  
+a progress bar at a time.  GUI front-ends may specify a file descriptor
+.IR fd ,
+in which case the progress bar information will be sent to that file descriptor.
+.TP
+.B \-M
+Do not check mounted filesystems and return an exit code of 0
+for mounted filesystems.
 .TP
 .B \-N
 Don't execute, just show what would be done.
@@ -277,8 +291,9 @@ You're almost certainly doing something that you shouldn't be doing
 with 
 .BR fsck.
 .PP
-Currently, standardized file system-specific options are somewhat in
-flux.  Although not guaranteed, the following options are supported
+Options to different filesystem-specific fsck's are not standardized.
+If in doubt, please consult the man pages of the filesystem-specific
+checker.  Although not guaranteed, the following options are supported
 by most file system checkers:
 .TP
 .B \-a
@@ -292,7 +307,20 @@ for backwards compatibility only.  This option is mapped to
 .B \-p
 option which is safe to use, unlike the 
 .B \-a 
-option that most file system checkers support.
+option that some file system checkers support.
+.TP
+.B \-n
+For some filesystem-specific checkers, the 
+.B \-n
+option will cause the fs-specific fsck to avoid attempting to repair any 
+problems, but simply report such problems to stdout.  This is however
+not true for all filesystem-specific checkers.  In particular, 
+.BR fsck.reiserfs (8)
+will not report any corruption if given this option.
+.BR fsck.minix (8)
+does not support the 
+.B \-n 
+option at all.
 .TP
 .B \-r
 Interactively repair the filesystem (ask for confirmations).  Note: It
@@ -301,6 +329,21 @@ run in parallel.  Also note that this is
 .BR e2fsck 's
 default behavior; it supports this option for backwards compatibility
 reasons only.
+.TP
+.B \-y
+For some filesystem-specific checkers, the 
+.B \-y 
+option will cause the fs-specific fsck to always attempt to fix any
+detected filesystem corruption automatically.  Sometimes an expert may
+be able to do better driving the fsck manually.  Note that 
+.B not
+all filesystem-specific checkers implement this option.  In particular 
+.BR fsck.minix (8)
+and
+.BR fsck.cramfs (8)
+does not support the
+.B -y
+option as of this writing.
 .SH AUTHOR
 Theodore Ts'o (tytso@mit.edu)
 .SH FILES
@@ -350,13 +393,22 @@ environment are searched.
 This environment variable allows the system administrator 
 to override the standard location of the 
 .B /etc/fstab
-file.  It is also use for developers who are testing
+file.  It is also useful for developers who are testing
 .BR fsck .
 .SH SEE ALSO
 .BR fstab (5),
 .BR mkfs (8),
-.BR fsck.minix (8),
 .BR fsck.ext2 (8)
 or
+.BR fsck.ext3 (8)
+or
 .BR e2fsck (8),
-.BR fsck.xiafs (8).
+.BR cramfsck (8),
+.BR fsck.minix (8),
+.BR fsck.msdos (8),
+.BR fsck.jfs (8),
+.BR fsck.nfs (8),
+.BR fsck.vfat (8),
+.BR fsck.xfs (8),
+.BR fsck.xiafs (8),
+.BR reiserfsck (8).