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.\" 4. Neither the name of the University nor the names of its contributors
14.\" may be used to endorse or promote products derived from this software
15.\" without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" @(#)fsck.8 8.4 (Berkeley) 5/9/95
| 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.\" 4. Neither the name of the University nor the names of its contributors
14.\" may be used to endorse or promote products derived from this software
15.\" without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" @(#)fsck.8 8.4 (Berkeley) 5/9/95
|
30.\" $FreeBSD: stable/10/sbin/fsck_ffs/fsck_ffs.8 253828 2013-07-31 04:51:12Z scottl $
| 30.\" $FreeBSD: stable/10/sbin/fsck_ffs/fsck_ffs.8 260178 2014-01-02 01:44:14Z scottl $
|
31.\"
32.Dd July 30, 2013
33.Dt FSCK_FFS 8
34.Os
35.Sh NAME
36.Nm fsck_ffs ,
37.Nm fsck_ufs
38.Nd file system consistency check and interactive repair
39.Sh SYNOPSIS
40.Nm
| 31.\"
32.Dd July 30, 2013
33.Dt FSCK_FFS 8
34.Os
35.Sh NAME
36.Nm fsck_ffs ,
37.Nm fsck_ufs
38.Nd file system consistency check and interactive repair
39.Sh SYNOPSIS
40.Nm
|
41.Op Fl BEFfnpryZ
| 41.Op Fl BEFfnpRryZ
|
42.Op Fl b Ar block
43.Op Fl c Ar level
44.Op Fl m Ar mode
45.Ar filesystem
46.Ar ...
47.Sh DESCRIPTION
48The specified disk partitions and/or file systems are checked.
49In "preen" or "check clean" mode the clean flag of each file system's
50superblock is examined and only those file systems that are not marked clean
51are checked.
52File systems are marked clean when they are unmounted,
53when they have been mounted read-only, or when
54.Nm
55runs on them successfully.
56If the
57.Fl f
58option is specified, the file systems
59will be checked regardless of the state of their clean flag.
60.Pp
61The kernel takes care that only a restricted class of innocuous file system
62inconsistencies can happen unless hardware or software failures intervene.
63These are limited to the following:
64.Pp
65.Bl -item -compact -offset indent
66.It
67Unreferenced inodes
68.It
69Link counts in inodes too large
70.It
71Missing blocks in the free map
72.It
73Blocks in the free map also in files
74.It
75Counts in the super-block wrong
76.El
77.Pp
78These are the only inconsistencies that
79.Nm
80with the
81.Fl p
82option will correct; if it encounters other inconsistencies, it exits
83with an abnormal return status and an automatic reboot will then fail.
84For each corrected inconsistency one or more lines will be printed
85identifying the file system on which the correction will take place,
86and the nature of the correction.
87After successfully correcting a file system,
88.Nm
89will print the number of files on that file system,
90the number of used and free blocks,
91and the percentage of fragmentation.
92.Pp
93If sent a
94.Dv QUIT
95signal,
96.Nm
97will finish the file system checks, then exit with an abnormal
98return status that causes an automatic reboot to fail.
99This is useful when you want to finish the file system checks during an
100automatic reboot,
101but do not want the machine to come up multiuser after the checks complete.
102.Pp
103If
104.Nm
105receives a
106.Dv SIGINFO
107(see the
108.Dq status
109argument for
110.Xr stty 1 )
111signal, a line will be written to the standard output indicating
112the name of the device currently being checked, the current phase
113number and phase-specific progress information.
114.Pp
115Without the
116.Fl p
117option,
118.Nm
119audits and interactively repairs inconsistent conditions for file systems.
120If the file system is inconsistent the operator is prompted for concurrence
121before each correction is attempted.
122It should be noted that some of the corrective actions which are not
123correctable under the
124.Fl p
125option will result in some loss of data.
126The amount and severity of data lost may be determined from the diagnostic
127output.
128The default action for each consistency correction
129is to wait for the operator to respond
130.Li yes
131or
132.Li no .
133If the operator does not have write permission on the file system
134.Nm
135will default to a
136.Fl n
137action.
138.Pp
139The following flags are interpreted by
140.Nm :
141.Bl -tag -width indent
142.It Fl B
143A check is done on the specified and possibly active file system.
144The set of corrections that can be done is limited to those done
145when running in preen mode (see the
146.Fl p
147flag).
148If unexpected errors are found,
149the file system is marked as needing a foreground check and
150.Nm
151exits without attempting any further cleaning.
152.It Fl E
153Clear unallocated blocks, notifying the underlying device that they
154are not used and that their contents may be discarded.
155This is useful for filesystems which have been mounted on systems
156without TRIM support, or with TRIM support disabled, as well as
157filesystems which have been copied from one device to another.
158.Pp
159See the
160.Fl E
161and
162.Fl t
163flags of
164.Xr newfs 8 ,
165and
166the
167.Fl t
168flag of
169.Xr tunefs 8 .
170.It Fl F
171Determine whether the file system needs to be cleaned immediately
172in foreground, or if its cleaning can be deferred to background.
173To be eligible for background cleaning it must have been running
174with soft updates, not have been marked as needing a foreground check,
175and be mounted and writable when the background check is to be done.
176If these conditions are met, then
177.Nm
178exits with a zero exit status.
179Otherwise it exits with a non-zero exit status.
180If the file system is clean,
181it will exit with a non-zero exit status so that the clean status
182of the file system can be verified and reported during the foreground
183checks.
184Note that when invoked with the
185.Fl F
186flag, no cleanups are done.
187The only thing that
188.Nm
189does is to determine whether a foreground or background
190check is needed and exit with an appropriate status code.
191.It Fl b
192Use the block specified immediately after the flag as
193the super block for the file system.
194An alternate super block is usually located at block 32 for UFS1,
195and block 160 for UFS2.
196.Pp
197See the
198.Fl N
199flag of
200.Xr newfs 8 .
201.It Fl C
202Check if file system was dismounted cleanly.
203If so, skip file system checks (like "preen").
204However, if the file system was not cleanly dismounted, do full checks,
205as if
206.Nm
207was invoked without
208.Fl C .
209.It Fl c
210Convert the file system to the specified level.
211Note that the level of a file system can only be raised.
212There are currently four levels defined:
213.Bl -tag -width indent
214.It 0
215The file system is in the old (static table) format.
216.It 1
217The file system is in the new (dynamic table) format.
218.It 2
219The file system supports 32-bit uid's and gid's,
220short symbolic links are stored in the inode,
221and directories have an added field showing the file type.
222.It 3
223If maxcontig is greater than one,
224build the free segment maps to aid in finding contiguous sets of blocks.
225If maxcontig is equal to one, delete any existing segment maps.
226.El
227.Pp
228In interactive mode,
229.Nm
230will list the conversion to be made
231and ask whether the conversion should be done.
232If a negative answer is given,
233no further operations are done on the file system.
234In preen mode,
235the conversion is listed and done if
236possible without user interaction.
237Conversion in preen mode is best used when all the file systems
238are being converted at once.
239The format of a file system can be determined from the
240first line of output from
241.Xr dumpfs 8 .
242.Pp
243This option implies the
244.Fl f
245flag.
246.It Fl f
247Force
248.Nm
249to check
250.Sq clean
251file systems when preening.
252.It Fl m
253Use the mode specified in octal immediately after the flag as the
254permission bits to use when creating the
255.Pa lost+found
256directory rather than the default 1777.
257In particular, systems that do not wish to have lost files accessible
258by all users on the system should use a more restrictive
259set of permissions such as 700.
260.It Fl n
261Assume a no response to all questions asked by
262.Nm
263except for
264.Ql CONTINUE? ,
265which is assumed to be affirmative;
266do not open the file system for writing.
267.It Fl p
268Preen file systems (see above).
| 42.Op Fl b Ar block
43.Op Fl c Ar level
44.Op Fl m Ar mode
45.Ar filesystem
46.Ar ...
47.Sh DESCRIPTION
48The specified disk partitions and/or file systems are checked.
49In "preen" or "check clean" mode the clean flag of each file system's
50superblock is examined and only those file systems that are not marked clean
51are checked.
52File systems are marked clean when they are unmounted,
53when they have been mounted read-only, or when
54.Nm
55runs on them successfully.
56If the
57.Fl f
58option is specified, the file systems
59will be checked regardless of the state of their clean flag.
60.Pp
61The kernel takes care that only a restricted class of innocuous file system
62inconsistencies can happen unless hardware or software failures intervene.
63These are limited to the following:
64.Pp
65.Bl -item -compact -offset indent
66.It
67Unreferenced inodes
68.It
69Link counts in inodes too large
70.It
71Missing blocks in the free map
72.It
73Blocks in the free map also in files
74.It
75Counts in the super-block wrong
76.El
77.Pp
78These are the only inconsistencies that
79.Nm
80with the
81.Fl p
82option will correct; if it encounters other inconsistencies, it exits
83with an abnormal return status and an automatic reboot will then fail.
84For each corrected inconsistency one or more lines will be printed
85identifying the file system on which the correction will take place,
86and the nature of the correction.
87After successfully correcting a file system,
88.Nm
89will print the number of files on that file system,
90the number of used and free blocks,
91and the percentage of fragmentation.
92.Pp
93If sent a
94.Dv QUIT
95signal,
96.Nm
97will finish the file system checks, then exit with an abnormal
98return status that causes an automatic reboot to fail.
99This is useful when you want to finish the file system checks during an
100automatic reboot,
101but do not want the machine to come up multiuser after the checks complete.
102.Pp
103If
104.Nm
105receives a
106.Dv SIGINFO
107(see the
108.Dq status
109argument for
110.Xr stty 1 )
111signal, a line will be written to the standard output indicating
112the name of the device currently being checked, the current phase
113number and phase-specific progress information.
114.Pp
115Without the
116.Fl p
117option,
118.Nm
119audits and interactively repairs inconsistent conditions for file systems.
120If the file system is inconsistent the operator is prompted for concurrence
121before each correction is attempted.
122It should be noted that some of the corrective actions which are not
123correctable under the
124.Fl p
125option will result in some loss of data.
126The amount and severity of data lost may be determined from the diagnostic
127output.
128The default action for each consistency correction
129is to wait for the operator to respond
130.Li yes
131or
132.Li no .
133If the operator does not have write permission on the file system
134.Nm
135will default to a
136.Fl n
137action.
138.Pp
139The following flags are interpreted by
140.Nm :
141.Bl -tag -width indent
142.It Fl B
143A check is done on the specified and possibly active file system.
144The set of corrections that can be done is limited to those done
145when running in preen mode (see the
146.Fl p
147flag).
148If unexpected errors are found,
149the file system is marked as needing a foreground check and
150.Nm
151exits without attempting any further cleaning.
152.It Fl E
153Clear unallocated blocks, notifying the underlying device that they
154are not used and that their contents may be discarded.
155This is useful for filesystems which have been mounted on systems
156without TRIM support, or with TRIM support disabled, as well as
157filesystems which have been copied from one device to another.
158.Pp
159See the
160.Fl E
161and
162.Fl t
163flags of
164.Xr newfs 8 ,
165and
166the
167.Fl t
168flag of
169.Xr tunefs 8 .
170.It Fl F
171Determine whether the file system needs to be cleaned immediately
172in foreground, or if its cleaning can be deferred to background.
173To be eligible for background cleaning it must have been running
174with soft updates, not have been marked as needing a foreground check,
175and be mounted and writable when the background check is to be done.
176If these conditions are met, then
177.Nm
178exits with a zero exit status.
179Otherwise it exits with a non-zero exit status.
180If the file system is clean,
181it will exit with a non-zero exit status so that the clean status
182of the file system can be verified and reported during the foreground
183checks.
184Note that when invoked with the
185.Fl F
186flag, no cleanups are done.
187The only thing that
188.Nm
189does is to determine whether a foreground or background
190check is needed and exit with an appropriate status code.
191.It Fl b
192Use the block specified immediately after the flag as
193the super block for the file system.
194An alternate super block is usually located at block 32 for UFS1,
195and block 160 for UFS2.
196.Pp
197See the
198.Fl N
199flag of
200.Xr newfs 8 .
201.It Fl C
202Check if file system was dismounted cleanly.
203If so, skip file system checks (like "preen").
204However, if the file system was not cleanly dismounted, do full checks,
205as if
206.Nm
207was invoked without
208.Fl C .
209.It Fl c
210Convert the file system to the specified level.
211Note that the level of a file system can only be raised.
212There are currently four levels defined:
213.Bl -tag -width indent
214.It 0
215The file system is in the old (static table) format.
216.It 1
217The file system is in the new (dynamic table) format.
218.It 2
219The file system supports 32-bit uid's and gid's,
220short symbolic links are stored in the inode,
221and directories have an added field showing the file type.
222.It 3
223If maxcontig is greater than one,
224build the free segment maps to aid in finding contiguous sets of blocks.
225If maxcontig is equal to one, delete any existing segment maps.
226.El
227.Pp
228In interactive mode,
229.Nm
230will list the conversion to be made
231and ask whether the conversion should be done.
232If a negative answer is given,
233no further operations are done on the file system.
234In preen mode,
235the conversion is listed and done if
236possible without user interaction.
237Conversion in preen mode is best used when all the file systems
238are being converted at once.
239The format of a file system can be determined from the
240first line of output from
241.Xr dumpfs 8 .
242.Pp
243This option implies the
244.Fl f
245flag.
246.It Fl f
247Force
248.Nm
249to check
250.Sq clean
251file systems when preening.
252.It Fl m
253Use the mode specified in octal immediately after the flag as the
254permission bits to use when creating the
255.Pa lost+found
256directory rather than the default 1777.
257In particular, systems that do not wish to have lost files accessible
258by all users on the system should use a more restrictive
259set of permissions such as 700.
260.It Fl n
261Assume a no response to all questions asked by
262.Nm
263except for
264.Ql CONTINUE? ,
265which is assumed to be affirmative;
266do not open the file system for writing.
267.It Fl p
268Preen file systems (see above).
|
| 269.It Fl R
270Instruct fsck_ffs to restart itself if it encounters certain errors that
271warrant another run. It will limit itself to a maximum of 10 restarts
272in a given run in order to avoid an endless loop with extremely corrupted
273filesystems.
|
269.It Fl r
270Free up excess unused inodes.
271Decreasing the number of preallocated inodes reduces the
272running time of future runs of
273.Nm
274and frees up space that can allocated to files.
275The
276.Fl r
277option is ignored when running in preen mode.
278.It Fl S
279Surrender on error.
280With this flag enabled, a hard error returned on disk i/o will cause
281.Nm
282to abort instead of continuing on and possibly tripping over more i/o errors.
283.It Fl y
284Assume a yes response to all questions asked by
285.Nm ;
286this should be used with great caution as this is a free license
287to continue after essentially unlimited trouble has been encountered.
288.It Fl Z
289Similar to
290.Fl E ,
291but overwrites unused blocks with zeroes.
292If both
293.Fl E
294and
295.Fl Z
296are specified, blocks are first zeroed and then erased.
297.El
298.Pp
299Inconsistencies checked are as follows:
300.Pp
301.Bl -enum -compact
302.It
303Blocks claimed by more than one inode or the free map.
304.It
305Blocks claimed by an inode outside the range of the file system.
306.It
307Incorrect link counts.
308.It
309Size checks:
310.Bl -item -offset indent -compact
311.It
312Directory size not a multiple of DIRBLKSIZ.
313.It
314Partially truncated file.
315.El
316.It
317Bad inode format.
318.It
319Blocks not accounted for anywhere.
320.It
321Directory checks:
322.Bl -item -offset indent -compact
323.It
324File pointing to unallocated inode.
325.It
326Inode number out of range.
327.It
328Directories with unallocated blocks (holes).
329.It
330Dot or dot-dot not the first two entries of a directory
331or having the wrong inode number.
332.El
333.It
334Super Block checks:
335.Bl -item -offset indent -compact
336.It
337More blocks for inodes than there are in the file system.
338.It
339Bad free block map format.
340.It
341Total free block and/or free inode count incorrect.
342.El
343.El
344.Pp
345Orphaned files and directories (allocated but unreferenced) are,
346with the operator's concurrence, reconnected by
347placing them in the
348.Pa lost+found
349directory.
350The name assigned is the inode number.
351If the
352.Pa lost+found
353directory does not exist, it is created.
354If there is insufficient space its size is increased.
355.Pp
356The full foreground
357.Nm
358checks for many more problems that may occur after an
359unrecoverable disk write error.
360Thus, it is recommended that you perform foreground
361.Nm
362on your systems periodically and whenever you encounter
363unrecoverable disk write errors or file-system\-related panics.
364.Sh FILES
365.Bl -tag -width /etc/fstab -compact
366.It Pa /etc/fstab
367contains default list of file systems to check.
368.El
369.Sh EXIT STATUS
370.Ex -std
371.Pp
372If the option
373.Fl F
374is used,
375.Nm
376exits 7 if the file system is clean.
377.Sh DIAGNOSTICS
378The diagnostics produced by
379.Nm
380are fully enumerated and explained in Appendix A of
381.Rs
382.%T "Fsck \- The UNIX File System Check Program"
383.Re
384.Sh SEE ALSO
385.Xr fs 5 ,
386.Xr fstab 5 ,
387.Xr fsck 8 ,
388.Xr fsdb 8 ,
389.Xr newfs 8 ,
390.Xr reboot 8
| 274.It Fl r
275Free up excess unused inodes.
276Decreasing the number of preallocated inodes reduces the
277running time of future runs of
278.Nm
279and frees up space that can allocated to files.
280The
281.Fl r
282option is ignored when running in preen mode.
283.It Fl S
284Surrender on error.
285With this flag enabled, a hard error returned on disk i/o will cause
286.Nm
287to abort instead of continuing on and possibly tripping over more i/o errors.
288.It Fl y
289Assume a yes response to all questions asked by
290.Nm ;
291this should be used with great caution as this is a free license
292to continue after essentially unlimited trouble has been encountered.
293.It Fl Z
294Similar to
295.Fl E ,
296but overwrites unused blocks with zeroes.
297If both
298.Fl E
299and
300.Fl Z
301are specified, blocks are first zeroed and then erased.
302.El
303.Pp
304Inconsistencies checked are as follows:
305.Pp
306.Bl -enum -compact
307.It
308Blocks claimed by more than one inode or the free map.
309.It
310Blocks claimed by an inode outside the range of the file system.
311.It
312Incorrect link counts.
313.It
314Size checks:
315.Bl -item -offset indent -compact
316.It
317Directory size not a multiple of DIRBLKSIZ.
318.It
319Partially truncated file.
320.El
321.It
322Bad inode format.
323.It
324Blocks not accounted for anywhere.
325.It
326Directory checks:
327.Bl -item -offset indent -compact
328.It
329File pointing to unallocated inode.
330.It
331Inode number out of range.
332.It
333Directories with unallocated blocks (holes).
334.It
335Dot or dot-dot not the first two entries of a directory
336or having the wrong inode number.
337.El
338.It
339Super Block checks:
340.Bl -item -offset indent -compact
341.It
342More blocks for inodes than there are in the file system.
343.It
344Bad free block map format.
345.It
346Total free block and/or free inode count incorrect.
347.El
348.El
349.Pp
350Orphaned files and directories (allocated but unreferenced) are,
351with the operator's concurrence, reconnected by
352placing them in the
353.Pa lost+found
354directory.
355The name assigned is the inode number.
356If the
357.Pa lost+found
358directory does not exist, it is created.
359If there is insufficient space its size is increased.
360.Pp
361The full foreground
362.Nm
363checks for many more problems that may occur after an
364unrecoverable disk write error.
365Thus, it is recommended that you perform foreground
366.Nm
367on your systems periodically and whenever you encounter
368unrecoverable disk write errors or file-system\-related panics.
369.Sh FILES
370.Bl -tag -width /etc/fstab -compact
371.It Pa /etc/fstab
372contains default list of file systems to check.
373.El
374.Sh EXIT STATUS
375.Ex -std
376.Pp
377If the option
378.Fl F
379is used,
380.Nm
381exits 7 if the file system is clean.
382.Sh DIAGNOSTICS
383The diagnostics produced by
384.Nm
385are fully enumerated and explained in Appendix A of
386.Rs
387.%T "Fsck \- The UNIX File System Check Program"
388.Re
389.Sh SEE ALSO
390.Xr fs 5 ,
391.Xr fstab 5 ,
392.Xr fsck 8 ,
393.Xr fsdb 8 ,
394.Xr newfs 8 ,
395.Xr reboot 8
|