sbin/fsck_lfs/fsck_lfs.8

   1 .\"     $NetBSD: fsck_lfs.8,v 1.21 2008/10/09 16:56:23 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1989, 1991, 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 .\"     @(#)fsck.8      8.3 (Berkeley) 11/29/94
  31 .\"
  32 .Dd October 9, 2008
  33 .Dt FSCK_LFS 8
  34 .Os
  35 .Sh NAME
  36 .Nm fsck_lfs
  37 .Nd Log-structured File System consistency check and interactive repair
  38 .Sh SYNOPSIS
  39 .Nm fsck_lfs
  40 .Op Fl dfpqU
  41 .Op Fl b Ar block
  42 .Op Fl m Ar mode
  43 .Op Fl y | n
  44 .Ar filesystem
  45 .Ar ...
  46 .Sh DESCRIPTION
  47 .Nm
  48 performs interactive filesystem consistency checks and repair for
  49 each of the filesystems specified on the command line.
  50 It is normally invoked from
  51 .Xr fsck 8 .
  52 .Pp
  53 The design of LFS takes care that no filesystem inconsistencies can
  54 happen unless hardware or software failures intervene.
  55 .Nm
  56 will report and optionally correct any such inconsistencies.
  57 .Pp
  58 For each corrected inconsistency one or more lines will be printed
  59 identifying the filesystem on which the correction will take place,
  60 and the nature of the correction.
  61 After successfully correcting a filesystem,
  62 .Nm
  63 will print the number of files on that filesystem,
  64 the number of used and free blocks,
  65 and the percentage of fragmentation.
  66 .Pp
  67 If sent a
  68 .Dv QUIT
  69 signal,
  70 .Nm
  71 will finish the filesystem checks, then exit with an abnormal return status.
  72 .Pp
  73 Without the
  74 .Fl p
  75 option,
  76 .Nm
  77 audits and interactively repairs inconsistent conditions for filesystems.
  78 If the filesystem is inconsistent, the operator is prompted for concurrence
  79 before each correction is attempted.
  80 It should be noted that some of the corrective actions will result in
  81 some loss of data.
  82 The amount and severity of data lost may be determined from the diagnostic
  83 output.
  84 The default action for each consistency correction
  85 is to wait for the operator to respond
  86 .Li yes
  87 or
  88 .Li no .
  89 If the operator does not have write permission on the filesystem
  90 .Nm
  91 will default to a
  92 .Fl n
  93 action.
  94 .Pp
  95 The following flags are interpreted by
  96 .Nm :
  97 .Bl -tag -width XbXblockXX
  98 .It Fl b Ar block
  99 Use
 100 .Ar block
 101 as the super block for the filesystem.
 102 .It Fl d
 103 Print debugging output.
 104 .It Fl f
 105 Force checking of file systems.
 106 Normally, if a file system is cleanly unmounted, the kernel will
 107 set a
 108 .Dq clean flag
 109 in the file system superblock, and
 110 .Nm
 111 will not check the file system.
 112 This option forces
 113 .Nm
 114 to check the file system, regardless of the state of the clean flag.
 115 .It Fl m Ar mode
 116 Use
 117 .Ar mode
 118 specified in octal as the permission bits to use when creating the
 119 .Pa lost+found
 120 directory rather than the default 1700.
 121 In particular, systems that do not wish to have lost files accessible
 122 by all users on the system should use a more restrictive
 123 set of permissions such as 700.
 124 .It Fl n
 125 Assume a no response to all questions asked by
 126 .Nm
 127 except for
 128 .Ql CONTINUE? ,
 129 which is assumed to be affirmative;
 130 do not open the filesystem for writing.
 131 .It Fl p
 132 Specify
 133 .Dq preen
 134 mode.
 135 Currently, in this mode
 136 .Nm
 137 rolls forward from the older checkpoint, and performs no other action.
 138 .It Fl q
 139 Quiet mode, do not output any messages for clean filesystems.
 140 .It Fl U
 141 Resolve user ids to user names.
 142 .It Fl y
 143 Assume a yes response to all questions asked by
 144 .Nm ;
 145 this should be used with great caution as this is a free license
 146 to continue after essentially unlimited trouble has been encountered.
 147 .El
 148 .Pp
 149 Inconsistencies checked are as follows:
 150 .Bl -enum -offset indent -compact
 151 .It
 152 Blocks claimed by more than one inode.
 153 .It
 154 Blocks claimed by an inode outside the range of the filesystem.
 155 .It
 156 Incorrect link counts.
 157 .It
 158 Size checks:
 159 .Bl -item -offset indent -compact
 160 .It
 161 Directory size not a multiple of DIRBLKSIZ.
 162 .It
 163 Partially truncated file.
 164 .El
 165 .It
 166 Bad inode format.
 167 .It
 168 Directory checks:
 169 .Bl -item -offset indent -compact
 170 .It
 171 File pointing to unallocated inode.
 172 .It
 173 Inode number out of range.
 174 .It
 175 Dot or dot-dot not the first two entries of a directory
 176 or having the wrong inode number.
 177 .El
 178 .It
 179 Super Block checks:
 180 .Bl -item -offset indent -compact
 181 .It
 182 More blocks for inodes than there are in the filesystem.
 183 .El
 184 .It
 185 Index File checks:
 186 .Bl -item -offset indent -compact
 187 .It
 188 .Dq \&In use
 189 inodes on free list, or free inodes not on free list.
 190 .It
 191 Segment block counts incorrect, or
 192 .Dq clean
 193 segments containing live data.
 194 .El
 195 .El
 196 .Pp
 197 Orphaned files and directories (allocated but unreferenced) are,
 198 with the operator's concurrence, reconnected by
 199 placing them in the
 200 .Pa lost+found
 201 directory.
 202 The name assigned is the inode number.
 203 If the
 204 .Pa lost+found
 205 directory does not exist, it is created.
 206 If there is insufficient space its size is increased.
 207 .Pp
 208 Because of inconsistencies between the block device and the buffer cache,
 209 the raw device should always be used.
 210 .Sh DIAGNOSTICS
 211 The diagnostics produced by
 212 .Nm
 213 are fully enumerated and explained in Appendix A of
 214 .Rs
 215 .%T "Fsck \- The UNIX File System Check Program"
 216 .Re
 217 .Sh SEE ALSO
 218 .Xr fstab 5 ,
 219 .Xr fsck 8 ,
 220 .Xr newfs_lfs 8 ,
 221 .Xr reboot 8
 222 .Sh HISTORY
 223 The
 224 .Nm
 225 program was first made available in
 226 .Nx 1.4 .
 227 .Sh AUTHORS
 228 Most of the
 229 .Nm
 230 program was taken from
 231 .Xr fsck_ffs 8 ;
 232 what was not was written by
 233 .An Konrad Schroder Aq perseant@NetBSD.org .