From: Darik Horn Date: Sat, 16 Mar 2013 20:54:32 +0000 (-0500) Subject: Create fsck.zfs and zhack man pages. X-Git-Url: https://git.camperquake.de/gitweb.cgi?a=commitdiff_plain;h=ac826e16682114ee7a41b7a4ca3d8fdde59d29dc;p=zfs.git 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 Supplements #518 --- diff --git a/man/man1/Makefile.am b/man/man1/Makefile.am index 54ff9e5..9d44398 100644 --- a/man/man1/Makefile.am +++ b/man/man1/Makefile.am @@ -1,4 +1,4 @@ -man_MANS = zpios.1 ztest.1 +man_MANS = zhack.1 zpios.1 ztest.1 EXTRA_DIST = $(man_MANS) install-data-local: diff --git a/man/man1/zhack.1 b/man/man1/zhack.1 new file mode 100644 index 0000000..26a46f1 --- /dev/null +++ b/man/man1/zhack.1 @@ -0,0 +1,99 @@ +'\" 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 . All rights reserved. +.\" +.TH zhack 1 "2013 MAR 16" "ZFS on Linux" "User Commands" +.SH NAME +.BR zhack " \- libzpool debugging tool" +.SH DESCRIPTION +This utility pokes configuration changes directly into a ZFS pool, +which is dangerous and can cause data corruption. +.SH SYNOPSIS +.LP +.BI "zhack [\-c " "cachefile" "] [\-d " "dir" "] <" "subcommand" "> [" "arguments" "]" +.SH OPTIONS +.HP +.BI "\-c" " cachefile" +.IP +Read the \fIpool\fR configuration from the \fIcachefile\fR, which is +/etc/zfs/zpool.cache by default. +.HP +.BI "\-d" " dir" +.IP +Search for \fIpool\fR members in the \fIdir\fR path. Can be specified +more than once. +.SH SUBCOMMANDS +.LP +.BI "feature stat " "pool" +.IP +List feature flags. +.LP +.BI "feature enable [\-d " "description" "] [\-r] " "pool guid" +.IP +Add a new feature to \fIpool\fR that is uniquely identified by +\fIguid\fR, which is specified in the same form as a zfs(8) user +property. +.IP +The \fIdescription\fR is a short human readable explanation of the new +feature. +.IP +The \fB\-r\fR switch indicates that \fIpool\fR can be safely opened +in read-only mode by a system that does not have the \fIguid\fR +feature. +.LP +.BI "feature ref [\-d|\-m] " "pool guid" +.IP +Increment the reference count of the \fIguid\fR feature in \fIpool\fR. +.IP +The \fB\-d\fR switch decrements the reference count of the \fIguid\fR +feature in \fIpool\fR. +.IP +The \fB\-m\fR switch indicates that the \fIguid\fR feature is now +required to read the pool MOS. +.SH EXAMPLES +.LP +.nf +# zhack feature stat tank + +for_read_obj: + org.illumos:lz4_compress = 0 +for_write_obj: + com.delphix:async_destroy = 0 + com.delphix:empty_bpobj = 0 +descriptions_obj: + com.delphix:async_destroy = Destroy filesystems asynchronously. + com.delphix:empty_bpobj = Snapshots use less space. + org.illumos:lz4_compress = LZ4 compression algorithm support. +.LP +# zhack feature enable -d 'Predict future disk failures.' \\ + tank com.example:clairvoyance +.LP +# zhack feature ref tank com.example:clairvoyance +.SH AUTHORS +This man page was written by Darik Horn . +.SH SEE ALSO +.BR splat (1), +.BR zfs (8), +.BR zpios (1), +.BR zpool-features (5), +.BR ztest (1) diff --git a/man/man1/ztest.1 b/man/man1/ztest.1 index b698f42..961a5b0 100644 --- a/man/man1/ztest.1 +++ b/man/man1/ztest.1 @@ -24,7 +24,7 @@ .\" Copyright (c) 2009 Michael Gebetsroither . All rights .\" reserved. .\" -.TH zpios 1 "2009 NOV 01" "ZFS on Linux" "User Commands" +.TH ztest 1 "2009 NOV 01" "ZFS on Linux" "User Commands" .SH NAME \fBztest\fR \- was written by the ZFS Developers as a ZFS unit test. diff --git a/man/man8/Makefile.am b/man/man8/Makefile.am index 23b39b7..be7bc1d 100644 --- a/man/man8/Makefile.am +++ b/man/man8/Makefile.am @@ -1,4 +1,13 @@ -man_MANS = mount.zfs.8 vdev_id.8 zdb.8 zfs.8 zinject.8 zpool.8 zstreamdump.8 +man_MANS = \ + fsck.zfs.8 \ + mount.zfs.8 \ + vdev_id.8 \ + zdb.8 \ + zfs.8 \ + zinject.8 \ + zpool.8 \ + zstreamdump.8 + EXTRA_DIST = $(man_MANS) install-data-local: diff --git a/man/man8/fsck.zfs.8 b/man/man8/fsck.zfs.8 new file mode 100644 index 0000000..08b4308 --- /dev/null +++ b/man/man8/fsck.zfs.8 @@ -0,0 +1,67 @@ +'\" 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 . All rights reserved. +.\" +.TH fsck.zfs 8 "2013 MAR 16" "ZFS on Linux" "System Administration Commands" + +.SH NAME +.BR fsck.zfs " \- Dummy ZFS filesystem checker." + +.SH SYNOPSIS +.LP +.BI "fsck.zfs [" "options" "] <" "dataset" ">" + +.SH DESCRIPTION +.LP +\fBfsck.zfs\fR is a shell stub that does nothing and always returns +true. It is installed by ZoL because some Linux distributions expect +a fsck helper for all filesystems. + +.SH OPTIONS +.HP +All \fIoptions\fR and the \fIdataset\fR are ignored. + +.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. + +.SH "BUGS" +.LP +On some systems, if the \fIdataset\fR is in a degraded pool, then it +might be appropriate for \fBfsck.zfs\fR to return exit code 4 to +indicate an uncorrected filesystem error. +.LP +Similarly, if the \fIdataset\fR is in a faulted pool and has a legacy +/etc/fstab record, then \fBfsck.zfs\fR should return exit code 8 to +indicate a fatal operational error. + +.SH "AUTHORS" +.LP +Darik Horn . + +.SH "SEE ALSO" +.BR fsck (8), +.BR fstab (5), +.BR zpool (8)