projects / mirror_zfs.git / blame
| Commit | Line | Data |
|---|---|---|
| ac826e16 DH |
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 | |
| 1d3ba0bf | 9 | .\" or https://opensource.org/licenses/CDDL-1.0. |
| ac826e16 DH |
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 | .\" | |
| ac826e16 DH |
21 | .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved. |
| 22 | .\" | |
| 2b42a1e5 AZ |
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 | |
| b46be903 DS |
37 | is a thin shell wrapper that at most checks the status of a dataset's container |
| 38 | pool. | |
| 2b42a1e5 | 39 | It is installed by OpenZFS because some Linux |
| 0c2eb3f5 | 40 | distributions expect a fsck helper for all filesystems. |
| 2b42a1e5 AZ |
41 | .Pp |
| 42 | If more than one | |
| 43 | .Ar dataset | |
| 44 | is specified, each is checked in turn and the results binary-ored. | |
| 45 | . | |
| 46 | .Sh OPTIONS | |
| 47 | Ignored. | |
| 48 | . | |
| 49 | .Sh NOTES | |
| 50 | ZFS datasets are checked by running | |
| 51 | .Nm zpool Cm scrub | |
| 52 | on the containing pool. | |
| 53 | An individual ZFS dataset is never checked independently of its pool, | |
| 54 | which is unlike a regular filesystem. | |
| 55 | .Pp | |
| 0c2eb3f5 | 56 | However, the |
| 2b42a1e5 AZ |
57 | .Xr fsck 8 |
| 58 | interface still allows it to communicate some errors: if the | |
| 59 | .Ar dataset | |
| 60 | is in a degraded pool, then | |
| 61 | .Nm | |
| 1b37cc1a AZ |
62 | will return exit code |
| 63 | .Sy 4 | |
| 64 | to indicate an uncorrected filesystem error. | |
| 2b42a1e5 AZ |
65 | .Pp |
| 66 | Similarly, if the | |
| 67 | .Ar dataset | |
| 68 | is in a faulted pool and has a legacy | |
| 69 | .Pa /etc/fstab | |
| 70 | record, then | |
| 71 | .Nm | |
| 1b37cc1a AZ |
72 | will return exit code |
| 73 | .Sy 8 | |
| 74 | to indicate a fatal operational error. | |
| 2b42a1e5 AZ |
75 | .Sh SEE ALSO |
| 76 | .Xr fstab 5 , | |
| 77 | .Xr fsck 8 , | |
| 78 | .Xr zpool-scrub 8 |