forked from openzfs/zfs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 openzfs#518
- Loading branch information
Showing
8 changed files
with
488 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| SUBDIRS = man5 man8 | ||
| SUBDIRS = man1 man5 man8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| man_MANS = zpios.1 ztest.1 | ||
| EXTRA_DIST = $(man_MANS) | ||
|
|
||
| install-data-local: | ||
| $(INSTALL) -d -m 0755 "$(DESTDIR)$(mandir)/man1" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| '\" 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 zpios 1 "2013 FEB 28" "ZFS on Linux" "User Commands" | ||
|
|
||
| .SH NAME | ||
| zpios \- Directly test the DMU. | ||
| .SH SYNOPSIS | ||
| .LP | ||
| .BI "zpios [options] <\-p " pool ">" | ||
|
|
||
| .SH DESCRIPTION | ||
| This utility runs in-kernel DMU performance and stress tests that do | ||
| not depend on the ZFS Posix Layer ("ZPL"). | ||
|
|
||
| .SH OPTIONS | ||
| .HP | ||
| .BI "\-s" " regex" ", \-\-threadcount" " regex" | ||
| .IP | ||
| Start this many threads for each test series, specified as a comma | ||
| delimited regular expression. (eg: "-s 1,2,3") | ||
| .IP | ||
| This option is mutually exclusive with the \fBthreadcount_*\fR | ||
| options. | ||
| .HP | ||
| .BI "\-l" " regex_low" ", \-\-threadcount_low" " regex_low" | ||
| .HP | ||
| .BI "\-h" " regex_high" ", \-\-threadcount_high" " regex_high" | ||
| .HP | ||
| .BI "\-e" " regex_incr" ", \-\-threadcount_incr" " regex_incr" | ||
| .IP | ||
| Start \fIregex_low\fR threads for the first test, | ||
| add \fIregex_incr\fR threads for each subsequent test, | ||
| and start \fIregex_high\fR threads for the last test. | ||
| .IP | ||
| These three options must be specified together and are mutually | ||
| exclusive with the \fBthreadcount\fR option. | ||
| .HP | ||
| .BI "\-n" " regex" ", \-\-regioncount" " regex" | ||
| .IP | ||
| Create this many regions for each test series, specified as a comma | ||
| delimited regular expression. (eg: "-n 512,4096,65536") | ||
| .IP | ||
| This option is mutually exclusive with the \fBregioncount_*\fR | ||
| options. | ||
| .HP | ||
| .BI "\-i" " regex_low" ", \-\-regioncount_low" " regex_low" | ||
| .HP | ||
| .BI "\-j" " regex_high" ", \-\-regioncount_high" " regex_high" | ||
| .HP | ||
| .BI "\-k" " regex_incr" ", \-\-regioncount_incr" " regex_incr" | ||
| .IP | ||
| Create \fIregex_low\fR regions for the first test, | ||
| add \fIregex_incr\fR regions for each subsequent test, and | ||
| create \fIregex_high\fR regions for the last test. | ||
| .IP | ||
| These three options must be specified together and are mutually | ||
| exclusive with the \fBregioncount\fR option. | ||
| .HP | ||
| .BI "\-o" " size" ", \-\-offset" " size" | ||
| .IP | ||
| Create regions at \fIsize\fR offset for each test series, specified as | ||
| a comma delimited regular expression with an optional unit suffix. | ||
| (eg: "-o 4M" means four megabytes.) | ||
| .IP | ||
| This option is mutually exclusive with the \fBoffset_*\fR options. | ||
| .HP | ||
| .BI "\-m" " size_low" ", \-\-offset_low" " size_low" | ||
| .HP | ||
| .BI "\-q" " size_high" ", \-\-offset_high" " size_high" | ||
| .HP | ||
| .BI "\-r" " size_incr" ", \-\-offset_incr" " size_incr" | ||
| .IP | ||
| Create a region at \fIsize_low\fR offset for the first test, add | ||
| \fIsize_incr\fR to the offset for each subsequent test, and create | ||
| a region at \fIsize_high\fR offset for the last test. | ||
| .IP | ||
| These three options must be specified together and are mutually | ||
| exclusive with the \fBoffset\fR option. | ||
| .HP | ||
| .BI "\-c" " size" ", \-\-chunksize" " size" | ||
| .IP | ||
| Use \fIsize\fR chunks for each test, specified as a comma delimited | ||
| regular expression with an optional unit suffix. (eg: "-c 1M" means | ||
| one megabyte.) The chunk size must be at least the region size. | ||
| .IP | ||
| This option is mutually exclusive with the \fBchunksize_*\fB options. | ||
| .HP | ||
| .BI "\-a" " size_low" ", \-\-chunksize_low" " size_low" | ||
| .HP | ||
| .BI "\-b" " size_high" ", \-\-chunksize_high" " size_high" | ||
| .HP | ||
| .BI "\-g" " size_incr" ", \-\-chunksize_incr" " size_incr" | ||
| .IP | ||
| Use a \fIsize_low\fR chunk size for the first test, add \fIsize_incr\fR | ||
| to the chunk size for each subsequent test, and use a \fIsize_high\fR | ||
| chunk size for the last test. | ||
| .IP | ||
| These three options must be specified together and are mutually | ||
| exclusive with the \fBchunksize\fR option. | ||
| .HP | ||
| .BI "\-L" " dmu_flags" ", \-\-load" " dmu_flags" | ||
| .IP | ||
| Specify \fIdmuio\fR for regular DMU_IO, \fIssf\fR for single shared | ||
| file access, or \fIfpp\fR for per thread access. Use commas to delimit | ||
| multiple flags. (eg: "-L dmuio,ssf") | ||
| .HP | ||
| .BI "\-p" " name" ", \-\-pool" " name" | ||
| .IP | ||
| The pool name, which is mandatory. | ||
| .HP | ||
| .BI "\-M" " test" ", \-\-name" " test" | ||
| .IP | ||
| An arbitrary string that appears in the program output. | ||
| .HP | ||
| .BI "-x, \-\-cleanup" | ||
| .IP | ||
| Enable the DMU_REMOVE flag. | ||
| .HP | ||
| .BI "\-P" " command" ", \-\-prerun" " command" | ||
| .IP | ||
| Invoke \fIcommand\fR from the kernel before running the test. Shell | ||
| expansion is not performed and the environment is set to | ||
| HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin. | ||
| .HP | ||
| .BI "\-R" " command" ", \-\-postrun" " command" | ||
| .IP | ||
| Invoke \fIcommand\fR from the kernel after running the test. Shell | ||
| expansion is not performed and the environment is set to | ||
| HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin. | ||
| .HP | ||
| .BI "\-G" " directory" ", \-\-log" " directory" | ||
| .IP | ||
| Put logging output in this directory. | ||
| .HP | ||
| .BI "\-I" " size" ", \-\-regionnoise" " size" | ||
| .IP | ||
| Randomly vary the \fBregionsize\fR parameter for each test | ||
| modulo \fIsize\fR bytes. | ||
| .HP | ||
| .BI "\-N" " size" ", \-\-chunknoise" " size" | ||
| .IP | ||
| Randomly vary the \fBchunksize\fR parameter for each test | ||
| modulo \fIsize\fR bytes. | ||
| .HP | ||
| .BI "\-T" " time" ", \-\-threaddelay" " time" | ||
| .IP | ||
| Randomly vary the execution time for each test | ||
| modulo \fItime\fR kernel jiffies. | ||
| .HP | ||
| .BI "\-V" "" ", \-\-verify" "" | ||
| .IP | ||
| Enable the DMU_VERIFY flag for trivial data verification. | ||
| .HP | ||
| .BI "\-z" "" ", \-\-zerocopy" "" | ||
| .IP | ||
| Enable the DMU_READ_ZC and DMU_WRITE_ZC flags, which are | ||
| currently unimplemented for Linux. | ||
| .IP | ||
| .HP | ||
| .BI "\-O" "" ", \-\-nowait" "" | ||
| .IP | ||
| Enable the DMU_WRITE_NOWAIT flag. | ||
| .HP | ||
| .BI "\-f" "" ", \-\-noprefetch" "" | ||
| .IP | ||
| Enable the DMU_READ_NOPF flag. | ||
| .HP | ||
| .BI "\-H" "" ", \-\-human\-readable" "" | ||
| .IP | ||
| Print PASS and FAIL results explicitly and put unit suffixes on large | ||
| numbers. | ||
| .HP | ||
| .BI "\-v" "" ", \-\-verbose" "" | ||
| .IP | ||
| Increase output verbosity. | ||
| .HP | ||
| .BI "\-?" " " ", \-\-help" " " | ||
| .IP | ||
| Print the usage message. | ||
| .SH "AUTHORS" | ||
| The original zpios implementation was created by Cluster File Systems | ||
| Inc and adapted to ZFS on Linux by Brian Behlendorf | ||
| <behlendorf1@llnl.gov>. | ||
|
|
||
| This man page was written by Darik Horn <dajhorn@vanadac.com>. | ||
| .SH "SEE ALSO" | ||
| .BR zpool (8), | ||
| .BR zfs (8) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
Oops, something went wrong.