Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / sbin / fsck_ffs / SMM.doc / 1.t
blob3d934e25352e7c70c58f5307159597ece54d5c78
1 .\"     $NetBSD: 1.t,v 1.3 1996/04/05 01:45:44 cgd Exp $
2 .\"
3 .\" Copyright (c) 1982, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)1.t 8.1 (Berkeley) 6/5/93
31 .\"
32 .ds RH Introduction
33 .NH
34 Introduction
35 .PP
36 This document reflects the use of
37 .I fsck_ffs
38 with the 4.2BSD and 4.3BSD file system organization.  This
39 is a revision of the
40 original paper written by
41 T. J. Kowalski.
42 .PP
43 When a UNIX
44 operating system is brought up, a consistency
45 check of the file systems should always be performed.
46 This precautionary measure helps to insure
47 a reliable environment for file storage on disk.
48 If an inconsistency is discovered,
49 corrective action must be taken.
50 .I Fsck_ffs
51 runs in two modes.
52 Normally it is run non-interactively by the system after 
53 a normal boot.
54 When running in this mode,
55 it will only make changes to the file system that are known
56 to always be correct.
57 If an unexpected inconsistency is found
58 .I fsck_ffs
59 will exit with a non-zero exit status, 
60 leaving the system running single-user.
61 Typically the operator then runs 
62 .I fsck_ffs
63 interactively.
64 When running in this mode,
65 each problem is listed followed by a suggested corrective action.
66 The operator must decide whether or not the suggested correction
67 should be made.
68 .PP
69 The purpose of this memo is to dispel the
70 mystique surrounding
71 file system inconsistencies.
72 It first describes the updating of the file system
73 (the calm before the storm) and
74 then describes file system corruption (the storm).
75 Finally,
76 the set of deterministic corrective actions
77 used by
78 .I fsck_ffs
79 (the Coast Guard
80 to the rescue) is presented.
81 .ds RH Overview of the File System