mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-05-22 10:37:35 +03:00
Create mount.zfs, zinject, and zpios man pages.
And update the automake templates to install them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #518
This commit is contained in:
Darik Horn
committed by
Brian Behlendorf
Brian Behlendorf
parent
5cd0add214
commit
cf2129e6dc
@@ -1,4 +1,4 @@
|
||||
man_MANS = vdev_id.8 zdb.8 zfs.8 zpool.8 zstreamdump.8
|
||||
man_MANS = mount.zfs.8 vdev_id.8 zdb.8 zfs.8 zinject.8 zpool.8 zstreamdump.8
|
||||
EXTRA_DIST = $(man_MANS)
|
||||
|
||||
install-data-local:
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
'\" 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.
|
||||
.\"
|
||||
.TH mount.zfs 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands"
|
||||
|
||||
.SH NAME
|
||||
mount.zfs \- mount a ZFS filesystem
|
||||
.SH SYNOPSIS
|
||||
.LP
|
||||
.BI "mount.zfs [\-sfnvh] [\-o " options "]" " dataset mountpoint
|
||||
|
||||
.SH DESCRIPTION
|
||||
.BR mount.zfs
|
||||
is part of the zfsutils package for Linux. It is a helper program that
|
||||
is usually invoked by the
|
||||
.BR mount (8)
|
||||
or
|
||||
.BR zfs (8)
|
||||
commands to mount a ZFS dataset.
|
||||
|
||||
All
|
||||
.I options
|
||||
are handled according to the FILESYSTEM INDEPENDENT MOUNT OPTIONS
|
||||
section in the
|
||||
.BR mount (8)
|
||||
manual, except for those described below.
|
||||
|
||||
The
|
||||
.I dataset
|
||||
parameter is a ZFS filesystem name, as output by the
|
||||
.B "zfs list -H -o name
|
||||
command. This parameter never has a leading slash character and is
|
||||
not a device name.
|
||||
|
||||
The
|
||||
.I mountpoint
|
||||
parameter is the path name of a directory.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI "\-s"
|
||||
Ignore bad or sloppy mount options.
|
||||
.TP
|
||||
.BI "\-f"
|
||||
Do a fake mount; do not perform the mount operation.
|
||||
.TP
|
||||
.BI "\-n"
|
||||
Do not update the /etc/mtab file.
|
||||
.TP
|
||||
.BI "\-v"
|
||||
Increase verbosity.
|
||||
.TP
|
||||
.BI "\-h"
|
||||
Print the usage message.
|
||||
.TP
|
||||
.BI "\-o legacy"
|
||||
This private flag indicates that the
|
||||
.I dataset
|
||||
has an entry in the /etc/fstab file.
|
||||
.TP
|
||||
.BI "\-o noxattr"
|
||||
This private flag disables extended attributes.
|
||||
.TP
|
||||
.BI "\-o xattr
|
||||
This private flag enables extended attributes and, if appropriate,
|
||||
adds a ZFS context to the selinux system policy.
|
||||
.TP
|
||||
.BI "\-o zfsutil"
|
||||
This private flag indicates that
|
||||
.BR mount (8)
|
||||
is being called by the
|
||||
.BR zfs (8)
|
||||
command.
|
||||
|
||||
.SH NOTES
|
||||
ZFS conventionally requires that the
|
||||
.I mountpoint
|
||||
be an empty directory, but the Linux implementation inconsistently
|
||||
enforces the requirement.
|
||||
|
||||
The
|
||||
.BR mount.zfs
|
||||
helper does not mount the contents of zvols.
|
||||
|
||||
.SH FILES
|
||||
.TP 18n
|
||||
.I /etc/fstab
|
||||
The static filesystem table.
|
||||
.TP
|
||||
.I /etc/mtab
|
||||
The mounted filesystem table.
|
||||
.SH "AUTHORS"
|
||||
The primary author of
|
||||
.BR mount.zfs
|
||||
is Brian Behlendorf <behlendorf1@llnl.gov>.
|
||||
|
||||
This man page was written by Darik Horn <dajhorn@vanadac.com>.
|
||||
.SH "SEE ALSO"
|
||||
.BR fstab (5),
|
||||
.BR mount (8),
|
||||
.BR zfs (8)
|
||||
@@ -0,0 +1,146 @@
|
||||
'\" 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.
|
||||
.\"
|
||||
.TH zinject 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands"
|
||||
|
||||
.SH NAME
|
||||
zinject \- ZFS Fault Injector
|
||||
.SH DESCRIPTION
|
||||
.BR zinject
|
||||
creates artificial problems in a ZFS pool by simulating data corruption or device failures. This program is dangerous.
|
||||
.SH SYNOPSIS
|
||||
.TP
|
||||
.B "zinject"
|
||||
List injection records.
|
||||
.TP
|
||||
.B "zinject \-b \fIobjset:object:level:blkd\fB [\-f \fIfrequency\fB] [\-amu] \fIpool\fB"
|
||||
Force an error into the pool at a bookmark.
|
||||
.TP
|
||||
.B "zinject \-c <\fIid\fB | all>
|
||||
Cancel injection records.
|
||||
.TP
|
||||
.B "zinject \-d \fIvdev\fB \-A <degrade|fault> \fIpool\fB
|
||||
Force a vdev into the DEGRADED or FAULTED state.
|
||||
.TP
|
||||
.B "zinject \-d \fIvdev\fB [\-e \fIdevice_error\fB] [\-L \fIlabel_error\fB] [\-T \fIfailure\fB] [\-F] \fIpool\fB"
|
||||
Force a vdev error.
|
||||
.TP
|
||||
.B "zinject \-I [\-s \fIseconds\fB | \-g \fItxgs\fB] \fIpool\fB"
|
||||
Simulate a hardware failure that fails to honor a cache flush.
|
||||
.TP
|
||||
.B "zinject \-p \fIfunction\fB \fIpool\fB
|
||||
Panic inside the specified function.
|
||||
.TP
|
||||
.B "zinject \-t data [\-e \fIdevice_error\fB] [\-f \fIfrequency\fB] [\-l \fIlevel\fB] [\-r \fIrange\fB] [\-amq] \fIpath\fB"
|
||||
Force an error into the contents of a file.
|
||||
.TP
|
||||
.B "zinject \-t dnode [\-e \fIdevice_error\fB] [\-f \fIfrequency\fB] [\-l \fIlevel\fB] [\-amq] \fIpath\fB"
|
||||
Force an error into the metadnode for a file or directory.
|
||||
.TP
|
||||
.B "zinject \-t \fImos_type\fB [\-e \fIdevice_error\fB] [\-f \fIfrequency\fB] [\-l \fIlevel\fB] [\-r \fIrange\fB] [\-amqu] \fIpool\fB"
|
||||
Force an error into the MOS of a pool.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI "\-a"
|
||||
Flush the ARC before injection.
|
||||
.TP
|
||||
.BI "\-b" " objset:object:level:start:end"
|
||||
Force an error into the pool at this bookmark tuple. Each number is
|
||||
in hexidecimal, and only one block can be specified.
|
||||
.TP
|
||||
.BI "\-d" " vdev"
|
||||
A vdev specified by path or GUID.
|
||||
.TP
|
||||
.BI "\-e" " device_error"
|
||||
Specify
|
||||
.BR "checksum" " for an ECKSUM error,"
|
||||
.BR "dtl" " for an ECHILD error,"
|
||||
.BR "io" " for an EIO error where reopening the device will succeed, or"
|
||||
.BR "nxio" " for an ENXIO error where reopening the device will fail."
|
||||
.TP
|
||||
.BI "\-f" " frequency"
|
||||
Only inject errors a fraction of the time. Expressed as an integer
|
||||
percentage between 1 and 100.
|
||||
.TP
|
||||
.BI "\-F"
|
||||
Fail faster. Do fewer checks.
|
||||
.TP
|
||||
.BI "\-g" " txgs"
|
||||
Run for this many transaction groups before reporting failure.
|
||||
.TP
|
||||
.BI "\-h"
|
||||
Print the usage message.
|
||||
.TP
|
||||
.BI "\-l" " level"
|
||||
Inject an error at a particular block level. The default is 0.
|
||||
.TP
|
||||
.BI "\-L" " label_error"
|
||||
Set the label error region to one of
|
||||
.BR " nvlist" ","
|
||||
.BR " pad1" ","
|
||||
.BR " pad2" ", or"
|
||||
.BR " uber" "."
|
||||
.TP
|
||||
.BI "\-m"
|
||||
Automatically remount the underlying filesystem.
|
||||
.TP
|
||||
.BI "\-q"
|
||||
Quiet mode. Only print the handler number added.
|
||||
.TP
|
||||
.BI "\-r" " range"
|
||||
Inject an error over a particular logical range of an object, which
|
||||
will be translated to the appropriate blkid range according to the
|
||||
object's properties.
|
||||
.TP
|
||||
.BI "\-s" " seconds"
|
||||
Run for this many seconds before reporting failure.
|
||||
.TP
|
||||
.BI "\-T" " failure"
|
||||
Set the failure type to one of
|
||||
.BR " all" ","
|
||||
.BR " claim" ","
|
||||
.BR " free" ","
|
||||
.BR " read" ", or"
|
||||
.BR " write" "."
|
||||
.TP
|
||||
.BI "\-t" " mos_type"
|
||||
Set this to
|
||||
.BR "mos " "for any data in the MOS,"
|
||||
.BR "mosdir " "for an object directory,"
|
||||
.BR "config " "for the pool configuration,"
|
||||
.BR "bpobj " "for the block pointer list,"
|
||||
.BR "spacemap " "for the space map,"
|
||||
.BR "metaslab " "for the metaslab, or"
|
||||
.BR "errlog " "for the persistent error log."
|
||||
.TP
|
||||
.BI "\-u"
|
||||
Unload the pool after injection.
|
||||
|
||||
.SH "AUTHORS"
|
||||
This man page was written by Darik Horn <dajhorn@vanadac.com>
|
||||
excerpting the \fBzinject\fR usage message and source code.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.BR zpool (8),
|
||||
.BR zfs (8)
|
||||
Reference in New Issue
Block a user