Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / fsck_msdosfs / fsck_msdosfs.8
1 .\"     $NetBSD: fsck_msdos.8,v 1.9 1997/10/17 11:19:58 ws Exp $
2 .\" $FreeBSD: src/sbin/fsck_msdosfs/fsck_msdosfs.8,v 1.3.2.2 2003/01/26 03:19:48 keramida Exp $
3 .\"
4 .\" Copyright (C) 1995 Wolfgang Solfrank
5 .\" Copyright (c) 1995 Martin Husemann
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by Martin Husemann
18 .\"     and Wolfgang Solfrank.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
24 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 .\"
34 .\"
35 .Dd August 13, 1995
36 .Dt FSCK_MSDOSFS 8
37 .Os
38 .Sh NAME
39 .Nm fsck_msdosfs
40 .Nd DOS/Windows (FAT) filesystem consistency checker
41 .Sh SYNOPSIS
42 .Nm
43 .Fl p
44 .Op Fl f
45 .Ar filesystem ...
46 .Nm
47 .Op Fl fny
48 .Ar filesystem ...
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility verifies and repairs
53 .Tn FAT
54 filesystems (more commonly known
55 as
56 .Tn DOS
57 filesystems).
58 .Pp
59 The first form of
60 .Nm
61 preens the specified filesystems.
62 It is normally started by
63 .Xr fsck 8
64 run from
65 .Pa /etc/rc
66 during automatic reboot, when a FAT filesystem is detected.
67 When preening file systems,
68 .Nm
69 will fix common inconsistencies non-interactively.
70 If more serious problems are found,
71 .Nm
72 does not try to fix them, indicates that it was not
73 successful, and exits.
74 .Pp
75 The second form of
76 .Nm
77 checks the specified file systems and tries to repair all
78 detected inconsistencies, requesting confirmation before
79 making any changes.
80 .Pp
81 The options are as follows:
82 .Bl -tag -width indent
83 .It Fl F
84 Compatibility with the wrapper
85 .Xr fsck 8
86 which seeks to determine whether the filesystem needs to be cleaned
87 immediately in foreground, or if its cleaning can be deferred to background.
88 FAT (MS-DOS) file systems must always be cleaned in the foreground.
89 A non-zero exit code is always returned for this option.
90 .It Fl f
91 This option is ignored by
92 .Nm ,
93 and is present only for compatibility with programs that
94 check other file system types for consistency, such as
95 .Xr fsck_ffs 8 .
96 .It Fl n
97 Causes
98 .Nm
99 to assume
100 .Dq Li no
101 as the answer to all operator
102 questions, except
103 .Dq Li CONTINUE? .
104 .It Fl p
105 Preen the specified filesystems.
106 .It Fl y
107 Causes
108 .Nm
109 to assume
110 .Dq Li yes
111 as the answer to all operator questions.
112 .El
113 .Sh SEE ALSO
114 .Xr fsck 8 ,
115 .Xr fsck_ffs 8 ,
116 .Xr mount_msdos 8
117 .Sh BUGS
118 The
119 .Nm
120 utility is
121 .Ud .
122 .Sh HISTORY
123 The
124 .Nm
125 utility first appeared in
126 .Fx 4.4 .