sbin/fsck_msdosfs: Bring in freebsd/freebsd@136be466 (s/filesystem/file system/)
[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 .\"
3 .\" Copyright (C) 1995 Wolfgang Solfrank
4 .\" Copyright (c) 1995 Martin Husemann
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 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD$
27 .\"
28 .Dd September 29, 2016
29 .Dt FSCK_MSDOSFS 8
30 .Os
31 .Sh NAME
32 .Nm fsck_msdosfs
33 .Nd DOS/Windows (FAT) file system consistency checker
34 .Sh SYNOPSIS
35 .Nm
36 .Fl p
37 .Op Fl f
38 .Ar filesystem ...
39 .Nm
40 .Op Fl fny
41 .Ar filesystem ...
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility verifies and repairs
46 .Tn FAT
47 file systems (more commonly known
48 as
49 .Tn DOS
50 file systems).
51 .Pp
52 The first form of
53 .Nm
54 preens the specified file systems.
55 It is normally started by
56 .Xr fsck 8
57 run from
58 .Pa /etc/rc
59 during automatic reboot, when a FAT file system is detected.
60 When preening file systems,
61 .Nm
62 will fix common inconsistencies non-interactively.
63 If more serious problems are found,
64 .Nm
65 does not try to fix them, indicates that it was not
66 successful, and exits.
67 .Pp
68 The second form of
69 .Nm
70 checks the specified file systems and tries to repair all
71 detected inconsistencies, requesting confirmation before
72 making any changes.
73 .Pp
74 The options are as follows:
75 .Bl -tag -width indent
76 .It Fl F
77 Compatibility with the wrapper
78 .Xr fsck 8
79 which seeks to determine whether the file system needs to be cleaned
80 immediately in foreground, or if its cleaning can be deferred to background.
81 FAT (MS-DOS) file systems must always be cleaned in the foreground.
82 A non-zero exit code is always returned for this option.
83 .It Fl f
84 This option is ignored by
85 .Nm ,
86 and is present only for compatibility with programs that
87 check other file system types for consistency, such as
88 .Xr fsck_ffs 8 .
89 .It Fl n
90 Causes
91 .Nm
92 to assume
93 .Dq Li no
94 as the answer to all operator
95 questions, except
96 .Dq Li CONTINUE? .
97 .It Fl p
98 Preen the specified file systems.
99 .It Fl y
100 Causes
101 .Nm
102 to assume
103 .Dq Li yes
104 as the answer to all operator questions.
105 .El
106 .Sh SEE ALSO
107 .Xr fsck 8 ,
108 .Xr fsck_ffs 8 ,
109 .Xr mount_msdos 8
110 .Sh HISTORY
111 The
112 .Nm
113 utility appeared in
114 .Nx 1.2 .
115 .Nm
116 first appeared in
117 .Fx 4.4 .
118 .Sh BUGS
119 The
120 .Nm
121 utility is currently under development.