386BSD 0.1 development

[unix-history] / usr / src / sbin / fsck / fsck.8

diff --git a/usr/src/sbin/fsck/fsck.8 b/usr/src/sbin/fsck/fsck.8
index 985068a..a7dae66 100644 (file)
--- a/usr/src/sbin/fsck/fsck.8
+++ b/usr/src/sbin/fsck/fsck.8
@@ -1,10 +1,37 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1989 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)fsck.8      6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH FSCK 8 ""
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)fsck.8      6.9 (Berkeley) 4/20/91
+.\"
+.TH FSCK 8 "April 20, 1991"

 .UC 4
 .de us
 \\$1\l'|0\(ul'
 .UC 4
 .de us
 \\$1\l'|0\(ul'


@@ -12,21 +39,27 @@
 .SH NAME
 fsck \- file system consistency check and interactive repair
 .SH SYNOPSIS
 .SH NAME
 fsck \- file system consistency check and interactive repair
 .SH SYNOPSIS

-.B /etc/fsck
+.B fsck

 .B \-p
 [
 .B \-p
 [

-filesystem ...
+.B \-m
+mode

 ]
 .br
 ]
 .br

-.B /etc/fsck
+.B fsck

 [
 .B \-b
 block#
 ] [
 [
 .B \-b
 block#
 ] [

+.B \-c
+] [

 .B \-y
 ] [
 .B \-n
 ] [
 .B \-y
 ] [
 .B \-n
 ] [

+.B \-m
+mode
+] [

 filesystem 
 ] ...
 .SH DESCRIPTION
 filesystem 
 ] ...
 .SH DESCRIPTION


@@ -36,22 +69,20 @@ preens a standard set of filesystems or the specified file systems.
 It is normally used in the script
 .B /etc/rc
 during automatic reboot.
 It is normally used in the script
 .B /etc/rc
 during automatic reboot.

-In this case
+Here

 .I fsck
 reads the table
 .B /etc/fstab
 to determine which file systems to check.
 .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.
+Only partitions in fstab that are mounted ``rw,'' ``rq'' or ``ro''
+and that have non-zero pass number are checked.
+Filesystems with pass number 1 (normally just the root filesystem)
+are checked one at a time.
+When pass 1 completes, all remaining filesystems are checked,
+running one process per disk drive.
+The disk drive containing each filesystem is inferred from the longest prefix
+of the device name that ends in a digit; the remaining characters are assumed
+to be the partition designator.

 .PP
 The system takes care that only a restricted class of innocuous
 inconsistencies can happen unless hardware or software failures intervene.
 .PP
 The system takes care that only a restricted class of innocuous
 inconsistencies can happen unless hardware or software failures intervene.


@@ -63,15 +94,15 @@ Unreferenced inodes
 Link counts in inodes too large
 .ns
 .IP
 Link counts in inodes too large
 .ns
 .IP

-Missing blocks in the free list
+Missing blocks in the free map

 .ns
 .IP
 .ns
 .IP

-Blocks in the free list also in files
+Blocks in the free map also in files

 .ns
 .IP
 Counts in the super-block wrong
 .PP
 .ns
 .IP
 Counts in the super-block wrong
 .PP

-These are the only inconsistencies which
+These are the only inconsistencies that

 .I fsck
 with the
 .B \-p
 .I fsck
 with the
 .B \-p


@@ -82,8 +113,16 @@ 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
 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.
+will print the number of files on that file system,
+the number of used and free blocks,
+and the percentage of fragmentation.
+.PP
+If sent a QUIT signal,
+.I fsck
+will finish the file system checks, then exit with an abnormal
+return status that causes an automatic reboot to fail.
+This is useful when to finish the file system checks during an automatic reboot,
+but do not want the machine to come up multiuser after the checks complete.

 .PP
 Without the
 .B \-p
 .PP
 Without the
 .B \-p


@@ -92,16 +131,15 @@ option,
 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.
 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
+It should be noted that some of the corrective actions which are not
+correctable under the

 .B \-p
 .B \-p

-option will result in some loss
-of data.
+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.
 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 
+If the operator does not have write permission on the file system

 .I fsck
 will default to a 
 .BR "\-n " action.
 .I fsck
 will default to a 
 .BR "\-n " action.


@@ -117,19 +155,56 @@ The following flags are interpreted by
 .TP 6
 .B \-b
 Use the block specified immediately after the flag as
 .TP 6
 .B \-b
 Use the block specified immediately after the flag as

-the super block for the file system.  Block 32 is always
+the super block for the file system.  Block 32 is usually

 an alternate super block.
 .TP 6
 an alternate super block.
 .TP 6

+.B \-l
+Limit the number of parallel checks to the number specified in the following
+argument.
+By default, the limit is the number of disks, running one process per disk.
+If a smaller limit is given, the disks are checked round-robin, one filesystem
+at a time.
+.TP 6
+.B \-m
+Use the mode specified in octal immediately after the flag as the
+permission bits to use when creating the lost+found directory
+rather than the default 1777.
+In particular, systems that do not wish to have lost files accessible
+by all users on the system should use a more restrictive
+set of permissions such as 700.
+.TP 6

 .B  \-y
 Assume a yes response to all questions asked by 
 .B  \-y
 Assume a yes response to all questions asked by 

-.I fsck;
+.IR 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 
 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;
+.I fsck
+except for ``CONTINUE?'', which is assumed to be affirmative;

 do not open the file system for writing.
 do not open the file system for writing.

+.TP 6
+.B  \-c
+If the file system is in the old (static table) format,
+convert it to the new (dynamic table) format.
+If the file system is in the new format,
+convert it to the old format provided the old format
+can support the filesystem configuration.
+In interactive mode,
+.I fsck
+will list the direction the conversion is to be made
+and ask whether the conversion should be done.
+If a negative answer is given,
+no further operations are done on the filesystem.
+In preen mode,
+the direction of the conversion is listed and done if
+possible without user interaction.
+Conversion in preen mode is best used when all the file systems
+are being converted at once.
+The format of a file system can be determined from the
+first line of output from 
+.IR dumpfs (8).

 .PP
 If no filesystems are given to 
 .I fsck
 .PP
 If no filesystems are given to 
 .I fsck


@@ -141,13 +216,13 @@ the file
 Inconsistencies checked are as follows:
 .TP 6
 1.
 Inconsistencies checked are as follows:
 .TP 6
 1.

-Blocks claimed by more than one inode or the free list.
+Blocks claimed by more than one inode or the free map.

 .br
 .br
 .ns
 .TP 6
 2.
 .br
 .br
 .ns
 .TP 6
 2.

-Blocks claimed by an inode or the free list outside the range of the file system.
+Blocks claimed by an inode outside the range of the file system.

 .br
 .br
 .ns
 .br
 .br
 .ns


@@ -165,6 +240,8 @@ Size checks:
 .IP "" 12
 Directory size not of proper format.
 .br
 .IP "" 12
 Directory size not of proper format.
 .br

+Partially truncated file.
+.br

 .br
 .ns
 .TP 6
 .br
 .ns
 .TP 6


@@ -190,6 +267,9 @@ File pointing to unallocated inode.
 .br
 Inode number out of range.
 .br
 .br
 Inode number out of range.
 .br

+Dot or dot-dot not the first two entries of a directory
+or having the wrong inode number.
+.br

 .br
 .ns
 .TP 6
 .br
 .ns
 .TP 6


@@ -199,14 +279,13 @@ Super Block checks:
 .br
 .ns
 .IP "" 12
 .br
 .ns
 .IP "" 12

-.br

 More blocks for inodes than there are in the file system.
 .br
 .br
 .ns
 .TP 6
 9.
 More blocks for inodes than there are in the file system.
 .br
 .br
 .ns
 .TP 6
 9.

-Bad free block list format.
+Bad free block map format.

 .br
 .br
 .ns
 .br
 .br
 .ns


@@ -219,21 +298,14 @@ with the operator's concurrence, reconnected by
 placing them in the 
 .B lost+found
 directory.
 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).
+The name assigned is the inode number.
+If the
+.I lost+found
+directory does not exist, it is created.
+If there is insufficient space its size is increased.

 .PP
 .PP

-Checking the raw device is almost always faster.
+Because of inconsistencies between the block device and the buffer cache,
+the raw device should always be used.

 .SH FILES
 .br
 .ns
 .SH FILES
 .br
 .ns


@@ -243,19 +315,12 @@ contains default list of file systems to check.
 .SH DIAGNOSTICS
 The diagnostics produced by 
 .I fsck
 .SH DIAGNOSTICS
 The diagnostics produced by 
 .I fsck

-are intended to be self-explanatory.
+are fully enumerated and explained in Appendix A of
+``Fsck \- The UNIX File System Check Program'' (SMM:5).

 .SH "SEE ALSO"
 fstab(5),
 fs(5),
 .SH "SEE ALSO"
 fstab(5),
 fs(5),

+fsdb(8),

 newfs(8),
 mkfs(8),
 newfs(8),
 mkfs(8),

-crash(8V),

 reboot(8)
 reboot(8)

-.SH BUGS
-Inode numbers for
-.BR . ""
-and
-.BR .. ""
-in each directory should be checked for validity.
-.PP
-There should be some way to start a \fBfsck \-p\fR at pass \fIn\fR.