manual page distributed with 4.1BSD
authorKirk McKusick <mckusick@ucbvax.Berkeley.EDU>
Sun, 28 Apr 1985 04:25:31 +0000 (20:25 -0800)
committerKirk McKusick <mckusick@ucbvax.Berkeley.EDU>
Sun, 28 Apr 1985 04:25:31 +0000 (20:25 -0800)
SCCS-vsn: sbin/fsck/fsck.8 4.1

usr/src/sbin/fsck/fsck.8 [new file with mode: 0644]

diff --git a/usr/src/sbin/fsck/fsck.8 b/usr/src/sbin/fsck/fsck.8
new file mode 100644 (file)
index 0000000..99cc34d
--- /dev/null
@@ -0,0 +1,323 @@
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)fsck.8      4.1 (Berkeley) %G%
+.\"
+.TH FSCK 8 "4/1/81"
+.UC 4
+.de us
+\\$1\l'|0\(ul'
+..
+.SH NAME
+fsck \- file system consistency check and interactive repair
+.SH SYNOPSIS
+.B /etc/fsck
+.B \-p
+[
+filesystem ...
+]
+.br
+.B /etc/fsck
+[
+.B \-y
+] [
+.B \-n
+] [
+.BR \-s X
+] [
+.BR \-S X
+] [
+.B \-t
+filename
+] [
+filesystem 
+] ...
+.SH DESCRIPTION
+The first form of
+.I fsck
+preens a standard set of filesystems or the specified file systems.
+It is normally used in the script
+.B /etc/rc
+during automatic reboot.
+In this case
+.I fsck
+reads the table
+.B /etc/fstab
+to determine which file systems to check.
+It uses the information there to inspect groups of disks in parallel taking
+maximum advantage of i/o overlap to check the file systems
+as quickly as possible.
+Normally, the root file system will be checked on pass 1, other
+``root'' (``a'' partition) file systems on pass 2, other
+small file systems on separate passes (e.g. the ``d'' file systems
+on pass 3 and the ``e'' file systems on pass 4), and finally
+the large user file systems on the last pass, e.g. pass 5.
+A pass number of 0 in fstab causes a disk to not be checked; similarly
+partitions which are not shown as to be mounted ``rw'' or ``ro''
+are not checked.
+.PP
+The system takes care that only a restricted class of innocuous
+inconsistencies can happen unless hardware or software failures intervene.
+These are limited to the following:
+.IP
+Unreferenced inodes
+.ns
+.IP
+Link counts in inodes too large
+.ns
+.IP
+Missing blocks in the free list
+.ns
+.IP
+Blocks in the free list also in files
+.ns
+.IP
+Counts in the super-block wrong
+.PP
+These are the only inconsistencies which
+.I fsck
+with the
+.B \-p
+option will correct; if it encounters other inconsistencies, it exits
+with an abnormal return status and an automatic reboot will then fail.
+For each corrected inconsistency one or more lines will be printed
+identifying the file system on which the correction will take place,
+and the nature of the correction.  After successfully correcting a file
+system,
+.I fsck
+will print the number of files on that file system and the number of
+used and free blocks.
+.PP
+Without the
+.B \-p
+option,
+.I fsck
+audits and interactively repairs inconsistent conditions for file systems. 
+If the file system is inconsistent the operator is prompted for concurrence
+before each correction is attempted.
+It should be noted that a number of the corrective actions which are not
+fixable under the
+.B \-p
+option will result in some loss
+of data.
+The amount and severity of data lost may be determined from the diagnostic
+output.
+The default action for each consistency correction
+is to wait for the operator to respond \fByes\fP or \fBno\fP.
+If the operator does not have write permission 
+.I fsck
+will default to a 
+.BR "\-n " action.
+.PP
+.I Fsck
+has more consistency checks than
+its predecessors
+.IR "check, dcheck, fcheck, " "and" " icheck"
+combined.
+.PP
+The following flags are interpreted by
+.I fsck.
+.TP 6
+.B  \-y
+Assume a yes response to all questions asked by 
+.I fsck;
+this should be used with great caution as this is a free license
+to continue after essentially unlimited trouble has been encountered.
+.TP 6
+.B  \-n
+Assume a no response to all questions asked by 
+.I fsck;
+do not open the file system for writing.
+.TP 6
+.BR \-s \fIX
+Ignore the actual free list and (unconditionally) reconstruct a new
+one by rewriting the super-block of the file system.  
+The file system should be unmounted while this is done; if this
+is not possible, care should be taken that the system is quiescent
+and that it is rebooted immediately afterwards.
+This precaution is necessary so that the old, bad, in-core copy
+of the superblock will not continue to be used, or written on the file system.
+.IP
+The
+.BR \-s \fIX
+option allows for creating an optimal free-list organization.
+The following forms of
+.I X
+are supported for the following devices:
+.sp
+.nf
+       \-s3 (RP03)
+       \-s4 (RP04, RP05, RP06)
+       \-sBlocks-per-cylinder\fB:\fRBlocks-to-skip (for anything else)
+.fi
+.IP "" 6
+If 
+.I X
+is not given,
+the values used when the filesystem was created
+are used.
+If these values were not specified, then the value
+.I 400:9
+is used.
+.TP 6
+.BR \-S \fIX
+Conditionally reconstruct the free list. This option
+is like
+.BR \-s \fIX
+above except that the free list is rebuilt only
+if there were no discrepancies discovered in the
+file system. Using
+.B \-S
+will force a no response to all questions asked
+by
+.I fsck.
+This option is useful for forcing free list reorganization
+on uncontaminated file systems.
+.TP 6
+.B \-t
+If
+.I fsck
+cannot obtain enough memory to keep its tables,
+it uses a scratch file. If the \f3\-t\fP option is
+specified, the file named in the next argument
+is used as the scratch file, if needed. Without the
+.BR "\-t " flag,
+.I fsck
+will prompt the operator for the name of the
+scratch file. The file chosen should not be on the
+filesystem being checked, and if it is not
+a special file or did not already exist, it is
+removed when
+.I fsck
+completes.
+.PP
+If no filesystems are given to 
+.I fsck
+then a default list of file systems is read from
+the file
+.BR /etc/fstab .
+.PP
+.ne 10
+Inconsistencies checked are as follows:
+.TP 6
+1.
+Blocks claimed by more than one inode or the free list.
+.br
+.br
+.ns
+.TP 6
+2.
+Blocks claimed by an inode or the free list outside the range of the file system.
+.br
+.br
+.ns
+.TP 6
+3.
+Incorrect link counts.
+.br
+.br
+.ns
+.TP 6
+4.
+Size checks:
+.br
+.ns
+.IP "" 12
+Directory size not 16-byte aligned.
+.br
+.br
+.ns
+.TP 6
+5.
+Bad inode format.
+.br
+.br
+.ns
+.TP 6
+6.
+Blocks not accounted for anywhere.
+.br
+.br
+.ns
+.TP 6
+7.
+Directory checks:
+.br
+.br
+.ns
+.IP "" 12
+File pointing to unallocated inode.
+.br
+Inode number out of range.
+.br
+.br
+.ns
+.TP 6
+8.
+Super Block checks:
+.br
+.br
+.ns
+.IP "" 12
+More than 65536 inodes.
+.br
+More blocks for inodes than there are in the file system.
+.br
+.br
+.ns
+.TP 6
+9.
+Bad free block list format.
+.br
+.br
+.ns
+.TP 6
+10.
+Total free block and/or free inode count incorrect.
+.PP
+Orphaned files and directories (allocated but unreferenced) are,
+with the operator's concurrence, reconnected by
+placing them in the 
+.B lost+found
+directory.
+The name assigned is the inode number. The only restriction
+is that the directory 
+.B lost+found
+must preexist
+in the root of the filesystem being checked and
+must have empty slots in which entries can be made.
+This is accomplished by making 
+.BR lost+found ,
+copying a number of files to the directory, and then removing them
+(before
+.I
+fsck
+is executed).
+.PP
+Checking the raw device is almost always faster.
+.SH FILES
+.br
+.ns
+.TP 21
+/etc/fstab
+contains default list of file systems to check.
+.SH DIAGNOSTICS
+The diagnostics produced by 
+.I fsck
+are intended to be self-explanatory.
+.SH "SEE ALSO"
+fstab(5), fs(5), crash(8), reboot(8)
+.SH BUGS
+Inode numbers for
+.BR . ""
+and
+.BR .. ""
+in each directory should be checked for validity.
+.PP
+\f3\-g\fP and \f3\-b\fP options from 
+.I check
+should be available in
+.I fsck.
+.PP
+There should be some way to start a \fBfsck \-p\fR at pass \fIn\fR.