More minor IPI work.
[dragonfly/vkernel-mp.git] / sbin / fsck / fsck.8
blob231361bd326e3a2d3ef047242bf6a074b9c3bde3
1 .\"
2 .\" Copyright (c) 1980, 1989, 1991, 1993
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgment:
15 .\"     This product includes software developed by the University of
16 .\"     California, Berkeley and its contributors.
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\"     @(#)fsck.8      8.4 (Berkeley) 5/9/95
34 .\" $FreeBSD: src/sbin/fsck/fsck.8,v 1.14.2.3 2001/01/23 23:11:07 iedowse Exp $
35 .\" $DragonFly: src/sbin/fsck/fsck.8,v 1.6 2007/04/21 15:34:26 swildner Exp $
36 .\"
37 .Dd April 20, 2007
38 .Dt FSCK 8
39 .Os
40 .Sh NAME
41 .Nm fsck
42 .Nd filesystem consistency check and interactive repair
43 .Sh SYNOPSIS
44 .Nm
45 .Fl p
46 .Op Fl f
47 .Op Fl m Ar mode
48 .Op Ar filesystem
49 .Ar ...
50 .Nm
51 .Op Fl Lny
52 .Op Fl b Ar block#
53 .Op Fl c Ar level
54 .Op Fl l Ar maxparallel
55 .Op Fl m Ar mode
56 .Op Ar filesystem
57 .Ar ...
58 .Sh DESCRIPTION
59 The first form of
60 .Nm
61 preens a standard set of filesystems or the specified filesystems.
62 It is normally used in the script
63 .Pa /etc/rc
64 during automatic reboot.
65 Here
66 .Nm
67 reads the table
68 .Pa /etc/fstab
69 to determine which filesystems to check.
70 Only partitions in fstab that are mounted ``rw,'' ``rq'' or ``ro''
71 and that have non-zero pass number are checked.
72 Filesystems with pass number 1 (normally just the root filesystem)
73 are checked one at a time.
74 When pass 1 completes, all remaining filesystems are checked,
75 running one process per disk drive.
76 The disk drive containing each filesystem is inferred from the longest prefix
77 of the device name that ends in a digit; the remaining characters are assumed
78 to be the partition designator.
79 .Pp
80 In "preen" mode the clean flag of each filesystem's superblock is examined
81 and only those filesystems that
82 are not marked clean are checked.
83 Filesystems are marked clean when they are unmounted,
84 when they have been mounted read-only, or when
85 .Nm
86 runs on them successfully.
87 If the
88 .Fl f
89 option is specified, the filesystems
90 will be checked regardless of the state of their clean flag.
91 .Pp
92 The kernel takes care that only a restricted class of innocuous filesystem
93 inconsistencies can happen unless hardware or software failures intervene.
94 These are limited to the following:
95 .Pp
96 .Bl -item -compact -offset indent
97 .It
98 Unreferenced inodes
99 .It
100 Link counts in inodes too large
102 Missing blocks in the free map
104 Blocks in the free map also in files
106 Counts in the super-block wrong
109 These are the only inconsistencies that
111 with the
112 .Fl p
113 option will correct; if it encounters other inconsistencies, it exits
114 with an abnormal return status and an automatic reboot will then fail.
115 For each corrected inconsistency one or more lines will be printed
116 identifying the filesystem on which the correction will take place,
117 and the nature of the correction.  After successfully correcting a filesystem,
119 will print the number of files on that filesystem,
120 the number of used and free blocks,
121 and the percentage of fragmentation.
123 If sent a
124 .Dv QUIT
125 signal,
127 will finish the filesystem checks, then exit with an abnormal
128 return status that causes an automatic reboot to fail.
129 This is useful when you want to finish the filesystem checks during an
130 automatic reboot,
131 but do not want the machine to come up multiuser after the checks complete.
135 receives a
136 .Dv SIGINFO
137 (see the
138 .Dq status
139 argument for
140 .Xr stty 1 )
141 signal, a line will be written to the standard output indicating
142 the name of the device currently being checked, the current phase
143 number and phase-specific progress information.
145 Without the
146 .Fl p
147 option,
149 audits and interactively repairs inconsistent conditions for filesystems.
150 If the filesystem is inconsistent the operator is prompted for concurrence
151 before each correction is attempted.
152 It should be noted that some of the corrective actions which are not
153 correctable under the
154 .Fl p
155 option will result in some loss of data.
156 The amount and severity of data lost may be determined from the diagnostic
157 output.
158 The default action for each consistency correction
159 is to wait for the operator to respond
160 .Li yes
162 .Li no .
163 If the operator does not have write permission on the filesystem
165 will default to a
166 .Fl n
167 action.
169 .Nm Fsck
170 has more consistency checks than
171 its predecessors
172 .Em check , dcheck , fcheck ,
174 .Em icheck
175 combined.
177 The following flags are interpreted by
178 .Nm .
179 .Bl -tag -width indent
180 .It Fl b
181 Use the block specified immediately after the flag as
182 the super block for the filesystem.  Block 32 is usually
183 an alternate super block.
184 .It Fl c
185 Convert the filesystem to the specified level.
186 Note that the level of a filesystem can only be raised.
187 .Bl -tag -width indent
188 There are currently four levels defined:
189 .It 0
190 The filesystem is in the old (static table) format.
191 .It 1
192 The filesystem is in the new (dynamic table) format.
193 .It 2
194 The filesystem supports 32-bit uid's and gid's,
195 short symbolic links are stored in the inode,
196 and directories have an added field showing the file type.
197 .It 3
198 If maxcontig is greater than one,
199 build the free segment maps to aid in finding contiguous sets of blocks.
200 If maxcontig is equal to one, delete any existing segment maps.
203 In interactive mode,
205 will list the conversion to be made
206 and ask whether the conversion should be done.
207 If a negative answer is given,
208 no further operations are done on the filesystem.
209 In preen mode,
210 the conversion is listed and done if
211 possible without user interaction.
212 Conversion in preen mode is best used when all the filesystems
213 are being converted at once.
214 The format of a filesystem can be determined from the
215 first line of output from
216 .Xr dumpfs 8 .
217 .It Fl f
218 Force
220 to check
221 .Sq clean
222 filesystems when preening.
223 .It Fl l
224 Limit the number of parallel checks to the number specified in the following
225 argument.
226 By default, the limit is the number of disks, running one process per disk.
227 If a smaller limit is given, the disks are checked round-robin, one filesystem
228 at a time.
229 .It Fl L
230 Just print the "last mounted on" information and exit, do no other checking.
231 .It Fl m
232 Use the mode specified in octal immediately after the flag as the
233 permission bits to use when creating the
234 .Pa lost+found
235 directory rather than the default 1777.
236 In particular, systems that do not wish to have lost files accessible
237 by all users on the system should use a more restrictive
238 set of permissions such as 700.
239 .It Fl n
240 Assume a no response to all questions asked by
242 except for
243 .Ql CONTINUE? ,
244 which is assumed to be affirmative;
245 do not open the filesystem for writing.
246 .It Fl p
247 Preen filesystems (see above).
248 .It Fl y
249 Assume a yes response to all questions asked by
250 .Nm ;
251 this should be used with great caution as this is a free license
252 to continue after essentially unlimited trouble has been encountered.
255 If no filesystems are given to
257 then a default list of filesystems is read from
258 the file
259 .Pa /etc/fstab .
261 .Bl -enum -compact
262 Inconsistencies checked are as follows:
264 Blocks claimed by more than one inode or the free map.
266 Blocks claimed by an inode outside the range of the filesystem.
268 Incorrect link counts.
270 Size checks:
271 .Bl -item -offset indent -compact
273 Directory size not a multiple of DIRBLKSIZ.
275 Partially truncated file.
278 Bad inode format.
280 Blocks not accounted for anywhere.
282 Directory checks:
283 .Bl -item -offset indent -compact
285 File pointing to unallocated inode.
287 Inode number out of range.
289 Directories with unallocated blocks (holes).
291 Dot or dot-dot not the first two entries of a directory
292 or having the wrong inode number.
295 Super Block checks:
296 .Bl -item -offset indent -compact
298 More blocks for inodes than there are in the filesystem.
300 Bad free block map format.
302 Total free block and/or free inode count incorrect.
306 Orphaned files and directories (allocated but unreferenced) are,
307 with the operator's concurrence, reconnected by
308 placing them in the
309 .Pa lost+found
310 directory.
311 The name assigned is the inode number.
312 If the
313 .Pa lost+found
314 directory does not exist, it is created.
315 If there is insufficient space its size is increased.
317 Because of inconsistencies between the block device and the buffer cache,
318 the raw device should always be used.
319 .Sh FILES
320 .Bl -tag -width /etc/fstab -compact
321 .It Pa /etc/fstab
322 contains default list of filesystems to check.
324 .Sh DIAGNOSTICS
325 The diagnostics produced by
327 are fully enumerated and explained in Appendix A of
329 .%T "Fsck \- The UNIX File System Check Program"
331 .Sh SEE ALSO
332 .Xr fs 5 ,
333 .Xr fstab 5 ,
334 .Xr fsdb 8 ,
335 .Xr newfs 8 ,
336 .Xr reboot 8