]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blob - misc/fsck.8.in
misc: add e2mmpstatus utility via dumpe2fs
[thirdparty/e2fsprogs.git] / misc / fsck.8.in
1 .\" -*- nroff -*-
2 .\" Copyright 1993, 1994, 1995 by Theodore Ts'o. All Rights Reserved.
3 .\" This file may be copied under the terms of the GNU Public License.
4 .\"
5 .TH FSCK 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
6 .SH NAME
7 fsck \- check and repair a Linux file system
8 .SH SYNOPSIS
9 .B fsck
10 [
11 .B \-sAVRTMNP
12 ]
13 [
14 .B \-C
15 [
16 .I fd
17 ]
18 ]
19 [
20 .B \-t
21 .I fstype
22 ]
23 .I [filesys ... ]
24 [\-\-] [
25 .B fs-specific-options
26 ]
27 .SH DESCRIPTION
28 .B fsck
29 is used to check and optionally repair one or more Linux file systems.
30 .I filesys
31 can be a device name (e.g.
32 .IR /dev/hdc1 ", " /dev/sdb2 ),
33 a mount point (e.g.
34 .IR / ", " /usr ", " /home ),
35 or an ext2 label or UUID specifier (e.g.
36 UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd or LABEL=root).
37 Normally, the
38 .B fsck
39 program will try to handle filesystems on different physical disk drives
40 in parallel to reduce the total amount of time needed to check all of the
41 filesystems.
42 .PP
43 If no filesystems are specified on the command line, and the
44 .B \-A
45 option is not specified,
46 .B fsck
47 will default to checking filesystems in
48 .B /etc/fstab
49 serially. This is equivalent to the
50 .B \-As
51 options.
52 .PP
53 The exit code returned by
54 .B fsck
55 is the sum of the following conditions:
56 .br
57 \ 0\ \-\ No errors
58 .br
59 \ 1\ \-\ File system errors corrected
60 .br
61 \ 2\ \-\ System should be rebooted
62 .br
63 \ 4\ \-\ File system errors left uncorrected
64 .br
65 \ 8\ \-\ Operational error
66 .br
67 \ 16\ \-\ Usage or syntax error
68 .br
69 \ 32\ \-\ Fsck canceled by user request
70 .br
71 \ 128\ \-\ Shared library error
72 .br
73 The exit code returned when multiple file systems are checked
74 is the bit-wise OR of the exit codes for each
75 file system that is checked.
76 .PP
77 In actuality,
78 .B fsck
79 is simply a front-end for the various file system checkers
80 (\fBfsck\fR.\fIfstype\fR) available under Linux. The file
81 system-specific checker is searched for in
82 .I /sbin
83 first, then in
84 .I /etc/fs
85 and
86 .IR /etc ,
87 and finally in the directories listed in the PATH environment
88 variable. Please see the file system-specific checker manual pages for
89 further details.
90 .SH OPTIONS
91 .TP
92 .B \-s
93 Serialize
94 .B fsck
95 operations. This is a good idea if you are checking multiple
96 filesystems and the checkers are in an interactive mode. (Note:
97 .BR e2fsck (8)
98 runs in an interactive mode by default. To make
99 .BR e2fsck (8)
100 run in a non-interactive mode, you must either specify the
101 .B \-p
102 or
103 .B \-a
104 option, if you wish for errors to be corrected automatically, or the
105 .B \-n
106 option if you do not.)
107 .TP
108 .BI \-t " fslist"
109 Specifies the type(s) of file system to be checked. When the
110 .B \-A
111 flag is specified, only filesystems that match
112 .I fslist
113 are checked. The
114 .I fslist
115 parameter is a comma-separated list of filesystems and options
116 specifiers. All of the filesystems in this comma-separated list may be
117 prefixed by a negation operator
118 .RB ' no '
119 or
120 .RB ' ! ',
121 which requests that only those filesystems not listed in
122 .I fslist
123 will be checked. If all of the filesystems in
124 .I fslist
125 are not prefixed by a negation operator, then only those filesystems
126 listed
127 in
128 .I fslist
129 will be checked.
130 .sp
131 Options specifiers may be included in the comma-separated
132 .IR fslist .
133 They must have the format
134 .BI opts= fs-option\fR.
135 If an options specifier is present, then only filesystems which contain
136 .I fs-option
137 in their mount options field of
138 .B /etc/fstab
139 will be checked. If the options specifier is prefixed by a negation
140 operator, then only
141 those filesystems that do not have
142 .I fs-option
143 in their mount options field of
144 .B /etc/fstab
145 will be checked.
146 .sp
147 For example, if
148 .B opts=ro
149 appears in
150 .IR fslist ,
151 then only filesystems listed in
152 .B /etc/fstab
153 with the
154 .B ro
155 option will be checked.
156 .sp
157 For compatibility with Mandrake distributions whose boot scripts
158 depend upon an unauthorized UI change to the
159 .B fsck
160 program, if a filesystem type of
161 .B loop
162 is found in
163 .IR fslist ,
164 it is treated as if
165 .B opts=loop
166 were specified as an argument to the
167 .B \-t
168 option.
169 .sp
170 Normally, the filesystem type is deduced by searching for
171 .I filesys
172 in the
173 .I /etc/fstab
174 file and using the corresponding entry.
175 If the type can not be deduced, and there is only a single filesystem
176 given as an argument to the
177 .B \-t
178 option,
179 .B fsck
180 will use the specified filesystem type. If this type is not
181 available, then the default file system type (currently ext2) is used.
182 .TP
183 .B \-A
184 Walk through the
185 .I /etc/fstab
186 file and try to check all file systems in one run. This option is
187 typically used from the
188 .I /etc/rc
189 system initialization file, instead of multiple commands for checking
190 a single file system.
191 .sp
192 The root filesystem will be checked first unless the
193 .B \-P
194 option is specified (see below). After that,
195 filesystems will be checked in the order specified by the
196 .I fs_passno
197 (the sixth) field in the
198 .I /etc/fstab
199 file.
200 Filesystems with a
201 .I fs_passno
202 value of 0 are skipped and are not checked at all. Filesystems with a
203 .I fs_passno
204 value of greater than zero will be checked in order,
205 with filesystems with the lowest
206 .I fs_passno
207 number being checked first.
208 If there are multiple filesystems with the same pass number,
209 fsck will attempt to check them in parallel, although it will avoid running
210 multiple filesystem checks on the same physical disk.
211 .sp
212 Hence, a very common configuration in
213 .I /etc/fstab
214 files is to set the root filesystem to have a
215 .I fs_passno
216 value of 1
217 and to set all other filesystems to have a
218 .I fs_passno
219 value of 2. This will allow
220 .B fsck
221 to automatically run filesystem checkers in parallel if it is advantageous
222 to do so. System administrators might choose
223 not to use this configuration if they need to avoid multiple filesystem
224 checks running in parallel for some reason --- for example, if the
225 machine in question is short on memory so that
226 excessive paging is a concern.
227 .TP
228 .B \-C\fR [ \fI "fd" \fR ]
229 Display completion/progress bars for those filesystem checkers (currently
230 only for ext2 and ext3) which support them. Fsck will manage the
231 filesystem checkers so that only one of them will display
232 a progress bar at a time. GUI front-ends may specify a file descriptor
233 .IR fd ,
234 in which case the progress bar information will be sent to that file descriptor.
235 .TP
236 .B \-M
237 Do not check mounted filesystems and return an exit code of 0
238 for mounted filesystems.
239 .TP
240 .B \-N
241 Don't execute, just show what would be done.
242 .TP
243 .B \-P
244 When the
245 .B \-A
246 flag is set, check the root filesystem in parallel with the other filesystems.
247 This is not the safest thing in the world to do,
248 since if the root filesystem is in doubt things like the
249 .BR e2fsck (8)
250 executable might be corrupted! This option is mainly provided
251 for those sysadmins who don't want to repartition the root
252 filesystem to be small and compact (which is really the right solution).
253 .TP
254 .B \-R
255 When checking all file systems with the
256 .B \-A
257 flag, skip the root file system (in case it's already mounted read-write).
258 .TP
259 .B \-T
260 Don't show the title on startup.
261 .TP
262 .B \-V
263 Produce verbose output, including all file system-specific commands
264 that are executed.
265 .TP
266 .B fs-specific-options
267 Options which are not understood by
268 .B fsck
269 are passed to the filesystem-specific checker. These arguments
270 .B must
271 not take arguments, as there is no
272 way for
273 .B fsck
274 to be able to properly guess which arguments take options and which
275 don't.
276 .IP
277 Options and arguments which follow the
278 .B \-\-
279 are treated as file system-specific options to be passed to the
280 file system-specific checker.
281 .IP
282 Please note that fsck is not
283 designed to pass arbitrarily complicated options to filesystem-specific
284 checkers. If you're doing something complicated, please just
285 execute the filesystem-specific checker directly. If you pass
286 .B fsck
287 some horribly complicated option and arguments, and it doesn't do
288 what you expect,
289 .B don't bother reporting it as a bug.
290 You're almost certainly doing something that you shouldn't be doing
291 with
292 .BR fsck.
293 .PP
294 Options to different filesystem-specific fsck's are not standardized.
295 If in doubt, please consult the man pages of the filesystem-specific
296 checker. Although not guaranteed, the following options are supported
297 by most file system checkers:
298 .TP
299 .B \-a
300 Automatically repair the file system without any questions (use
301 this option with caution). Note that
302 .BR e2fsck (8)
303 supports
304 .B \-a
305 for backwards compatibility only. This option is mapped to
306 .BR e2fsck 's
307 .B \-p
308 option which is safe to use, unlike the
309 .B \-a
310 option that some file system checkers support.
311 .TP
312 .B \-n
313 For some filesystem-specific checkers, the
314 .B \-n
315 option will cause the fs-specific fsck to avoid attempting to repair any
316 problems, but simply report such problems to stdout. This is however
317 not true for all filesystem-specific checkers. In particular,
318 .BR fsck.reiserfs (8)
319 will not report any corruption if given this option.
320 .BR fsck.minix (8)
321 does not support the
322 .B \-n
323 option at all.
324 .TP
325 .B \-r
326 Interactively repair the filesystem (ask for confirmations). Note: It
327 is generally a bad idea to use this option if multiple fsck's are being
328 run in parallel. Also note that this is
329 .BR e2fsck 's
330 default behavior; it supports this option for backwards compatibility
331 reasons only.
332 .TP
333 .B \-y
334 For some filesystem-specific checkers, the
335 .B \-y
336 option will cause the fs-specific fsck to always attempt to fix any
337 detected filesystem corruption automatically. Sometimes an expert may
338 be able to do better driving the fsck manually. Note that
339 .B not
340 all filesystem-specific checkers implement this option. In particular
341 .BR fsck.minix (8)
342 and
343 .BR fsck.cramfs (8)
344 does not support the
345 .B -y
346 option as of this writing.
347 .SH AUTHOR
348 Theodore Ts'o (tytso@mit.edu)
349 .SH FILES
350 .IR /etc/fstab .
351 .SH ENVIRONMENT VARIABLES
352 The
353 .B fsck
354 program's behavior is affected by the following environment variables:
355 .TP
356 .B FSCK_FORCE_ALL_PARALLEL
357 If this environment variable is set,
358 .B fsck
359 will attempt to run all of the specified filesystems in parallel,
360 regardless of whether the filesystems appear to be on the same
361 device. (This is useful for RAID systems or high-end storage systems
362 such as those sold by companies such as IBM or EMC.)
363 .TP
364 .B FSCK_MAX_INST
365 This environment variable will limit the maximum number of file system
366 checkers that can be running at one time. This allows configurations
367 which have a large number of disks to avoid
368 .B fsck
369 starting too many file system checkers at once, which might overload
370 CPU and memory resources available on the system. If this value is
371 zero, then an unlimited number of processes can be spawned. This is
372 currently the default, but future versions of
373 .B fsck
374 may attempt to automatically determine how many file system checks can
375 be run based on gathering accounting data from the operating system.
376 .TP
377 .B PATH
378 The
379 .B PATH
380 environment variable is used to find file system checkers. A set of
381 system directories are searched first:
382 .BR /sbin ,
383 .BR /sbin/fs.d ,
384 .BR /sbin/fs ,
385 .BR /etc/fs ,
386 and
387 .BR /etc .
388 Then the set of directories found in the
389 .B PATH
390 environment are searched.
391 .TP
392 .B FSTAB_FILE
393 This environment variable allows the system administrator
394 to override the standard location of the
395 .B /etc/fstab
396 file. It is also useful for developers who are testing
397 .BR fsck .
398 .SH SEE ALSO
399 .BR fstab (5),
400 .BR mkfs (8),
401 .BR fsck.ext2 (8)
402 or
403 .BR fsck.ext3 (8)
404 or
405 .BR e2fsck (8),
406 .BR cramfsck (8),
407 .BR fsck.minix (8),
408 .BR fsck.msdos (8),
409 .BR fsck.jfs (8),
410 .BR fsck.nfs (8),
411 .BR fsck.vfat (8),
412 .BR fsck.xfs (8),
413 .BR fsck.xiafs (8),
414 .BR reiserfsck (8).