xref: /freebsd/sys/contrib/openzfs/man/man8/fsck.zfs.8 (revision 9768746b)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or https://opensource.org/licenses/CDDL-1.0.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
22.\"
23.Dd May 26, 2021
24.Dt FSCK.ZFS 8
25.Os
26.
27.Sh NAME
28.Nm fsck.zfs
29.Nd dummy ZFS filesystem checker
30.Sh SYNOPSIS
31.Nm
32.Op Ar options
33.Ar dataset Ns No …
34.
35.Sh DESCRIPTION
36.Nm
37is a thin shell wrapper that at most checks the status of a dataset's container
38pool.
39It is installed by OpenZFS because some Linux
40distributions expect a fsck helper for all filesystems.
41.Pp
42If more than one
43.Ar dataset
44is specified, each is checked in turn and the results binary-ored.
45.
46.Sh OPTIONS
47Ignored.
48.
49.Sh NOTES
50ZFS datasets are checked by running
51.Nm zpool Cm scrub
52on the containing pool.
53An individual ZFS dataset is never checked independently of its pool,
54which is unlike a regular filesystem.
55.Pp
56However, the
57.Xr fsck 8
58interface still allows it to communicate some errors: if the
59.Ar dataset
60is in a degraded pool, then
61.Nm
62will return exit code
63.Sy 4
64to indicate an uncorrected filesystem error.
65.Pp
66Similarly, if the
67.Ar dataset
68is in a faulted pool and has a legacy
69.Pa /etc/fstab
70record, then
71.Nm
72will return exit code
73.Sy 8
74to indicate a fatal operational error.
75.Sh SEE ALSO
76.Xr fstab 5 ,
77.Xr fsck 8 ,
78.Xr zpool-scrub 8
79