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