Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity
zfs/man/man8/fsck.zfs.8

72 lines
2.1 KiB
Groff
Raw Normal View History

Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
'\" t
.\"
.\" CDDL HEADER START
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
.\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
.\"
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
.TH FSCK.ZFS 8 "Mar 27, 2021" OpenZFS
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.SH NAME
Fix NAME section of manpages zhack and fsck.zfs. In Debian GNU/Linux a program called 'linitian' is used to make sure that packages conforms to the Debian GNU/Linux packaging guide lines. This fixes the problem reported as: W: zfsutils: manpage-has-bad-whatis-entry usr/share/man/man1/zhack.1.gz W: zfsutils: manpage-has-bad-whatis-entry usr/share/man/man8/fsck.zfs.8.gz Not something that ZoL needs to addhere to, but every other man page have their NAME section in a special way - why not these two as well? Signed-off-by: Turbo Fredriksson <turbo@bayour.com> Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #2161
2014-03-05 10:07:02 +00:00
fsck.zfs \- Dummy ZFS filesystem checker.
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.SH SYNOPSIS
.LP
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
.BI "fsck.zfs [" "options" "] <" "dataset" ">…"
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.SH DESCRIPTION
.LP
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
\fBfsck.zfs\fR is a thin shell wrapper that at most checks the status of a
dataset's container pool. It is installed by OpenZFS because some Linux
distributions expect a fsck helper for all filesystems.
.LP
If more than one \fIdataset\fR is specified, each is checked in turn
and results binary ored.
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.SH OPTIONS
.HP
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
All \fIoptions\fR are ignored.
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.SH "NOTES"
.LP
ZFS datasets are checked by running \fBzpool scrub\fR on the
containing pool. An individual ZFS dataset is never checked
independently of its pool, which is unlike a regular filesystem.
.LP
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
However, the
.BR fsck (8)
interface still allows it to communicate some errors:
if the \fIdataset\fR is in a degraded pool, then \fBfsck.zfs\fR will
return exit code 4 to indicate an uncorrected filesystem error.
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
.LP
Similarly, if the \fIdataset\fR is in a faulted pool and has a legacy
fsck.zfs: implement 4/8 exit codes as suggested in manpage Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #11806
2021-03-31 17:49:56 +00:00
/etc/fstab record, then \fBfsck.zfs\fR will return exit code 8 to
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-16 20:54:32 +00:00
indicate a fatal operational error.
.SH "AUTHORS"
.LP
Darik Horn <dajhorn@vanadac.com>.
.SH "SEE ALSO"
.BR fsck (8),
.BR fstab (5),
Reorganize zpool(8) man page into sections Moved subcommand topics into individual manpages. Reordered and grouped the list of subcommands by topic. Moved concepts overview to `zpoolconcepts.8` and the long list of available pool properties to `zpoolprops.8`. Internal cross-references copied from `zpool.8` needed to be converted to `.Xr` external references to new subcommand manual pages. Move `autotrim` into lexical order, autotrim tacked onto the end of a list. Now it is in alphabetical order. Clarify attach/detach description. Description was too specific to command syntax. Overview clarifies reason for attaching or detaching a device. Clarify replace description, don't refer to subcommand arguments. Clarify split command description, say what split actually does and why you'd want to do it. Clarify description of upgrade, and simplify the zpool.8 wording of the zpool-upgrade(8) description. Clarify description of import, detail what zpool-import(8) actually does. Add appropriate SEE ALSO sections. Divided zpool subcommand manual pages need their own SEE ALSO sections. Also modified fsck.zfs.8 to point directly to zfs-scrub.8 and zed.8.in to include a direct reference to zfs-events.8 Reviewed-by: Matt Ahrens <matt@delphix.com> Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ross Williams <ross@ross-williams.net> Closes #9564
2019-11-13 17:21:07 +00:00
.BR zpool-scrub (8)