aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXin LI <delphij@FreeBSD.org>2014-03-20 19:19:11 +0000
committerXin LI <delphij@FreeBSD.org>2014-03-20 19:19:11 +0000
commit90eb4a54b8f50bb2968fd85166d86e484e18db34 (patch)
treed98d6188e3e718d823083b5e9954b764258cc35c
parent4d386a222c27084b5ddaf13d2b9dd7f879038525 (diff)
downloadsrc-90eb4a54b8f50bb2968fd85166d86e484e18db34.tar.gz
src-90eb4a54b8f50bb2968fd85166d86e484e18db34.zip
3947 zpool(1M) references nonexistent zfs-features(5)
4540 zpool(1M) man page doesn't describe "readonly" property 3948 zfs sync=default is not accepted 4611 zfs(1M) still mentions 'send -r' in synopsis 4415 zpool(1M) man page missing "import -m" description illumos/illumos-gate@409f1c06a8ed7e94e186a77bff5bfe5f77c5ebb1
Notes
Notes: svn path=/vendor/illumos/dist/; revision=263436
-rw-r--r--man/man1m/zdb.1m5
-rw-r--r--man/man1m/zfs.1m11
-rw-r--r--man/man1m/zpool.1m117
3 files changed, 112 insertions, 21 deletions
diff --git a/man/man1m/zdb.1m b/man/man1m/zdb.1m
index 5336e1e25f13..4f67ff8e88c0 100644
--- a/man/man1m/zdb.1m
+++ b/man/man1m/zdb.1m
@@ -13,7 +13,7 @@
.\" Copyright 2012, Richard Lowe.
.\" Copyright (c) 2012 by Delphix. All rights reserved.
.\"
-.TH "ZDB" "1M" "February 15, 2012" "" ""
+.TH "ZDB" "1M" "March 6, 2014" "" ""
.SH "NAME"
\fBzdb\fR - Display zpool debugging and consistency information
@@ -460,8 +460,7 @@ Dataset rpool/swap [ZVOL], ID 59, cr_txg 356, 486M, 2 objects
.sp
.LP
-\fBExample 3 \fRDisplay basic information about object 0 in
-'rpool/export/home'
+\fBExample 3 \fRDisplay basic information about object 0 in 'rpool/export/home'
.sp
.in +2
.nf
diff --git a/man/man1m/zfs.1m b/man/man1m/zfs.1m
index 23958f984bfc..dca47ddf9523 100644
--- a/man/man1m/zfs.1m
+++ b/man/man1m/zfs.1m
@@ -26,8 +26,9 @@
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
.\" Copyright 2013 Nexenta Systems, Inc. All Rights Reserved.
.\" Copyright (c) 2013, Joyent, Inc. All rights reserved.
+.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
.\"
-.TH ZFS 1M "Oct 16, 2013"
+.TH ZFS 1M "March 6, 2014"
.SH NAME
zfs \- configures ZFS file systems
.SH SYNOPSIS
@@ -175,7 +176,7 @@ zfs \- configures ZFS file systems
.LP
.nf
-\fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
+\fBzfs\fR \fBsend\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
.fi
.LP
@@ -1381,12 +1382,12 @@ the file system as discussed in the "Snapshots" section. The default value is
.sp
.ne 2
.na
-\fB\fBsync\fR=\fBdefault\fR | \fBalways\fR | \fBdisabled\fR\fR
+\fB\fBsync\fR=\fBstandard\fR | \fBalways\fR | \fBdisabled\fR\fR
.ad
.sp .6
.RS 4n
Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC).
-\fBdefault\fR is the POSIX specified behavior of ensuring all synchronous
+\fBstandard\fR is the POSIX specified behavior of ensuring all synchronous
requests are written to stable storage and all devices are flushed to ensure
data is not cached by device controllers (this is the default). \fBalways\fR
causes every file system transaction to be written and flushed before its
@@ -2832,7 +2833,6 @@ See \fBzpool-features\fR(5) for details on ZFS feature flags and the
.RE
-.RE
.sp
.ne 2
.na
@@ -2957,7 +2957,6 @@ The format of the stream is committed. You will be able to receive your streams
on future versions of \fBZFS\fR.
.RE
-.RE
.sp
.ne 2
.na
diff --git a/man/man1m/zpool.1m b/man/man1m/zpool.1m
index 0da5282c9d34..061f4c40d360 100644
--- a/man/man1m/zpool.1m
+++ b/man/man1m/zpool.1m
@@ -14,7 +14,7 @@
.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
.\" own identifying information:
.\" Portions Copyright [yyyy] [name of copyright owner]
-.TH ZPOOL 1M "Mar 16, 2012"
+.TH ZPOOL 1M "Mar 6, 2014"
.SH NAME
zpool \- configures ZFS storage pools
.SH SYNOPSIS
@@ -77,23 +77,23 @@ zpool \- configures ZFS storage pools
.LP
.nf
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
- [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR
+ [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR
.fi
.LP
.nf
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
- [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR]
+ [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR |\fIid\fR [\fInewpool\fR]
.fi
.LP
.nf
-\fBzpool iostat\fR [\fB-T\fR u | d ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
+\fBzpool iostat\fR [\fB-T\fR \fBu\fR | \fBd\fR ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
.fi
.LP
.nf
-\fBzpool list\fR [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ...
+\fBzpool list\fR [\fB-T\fR \fBu\fR | \fBd\fR ] [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
.fi
.LP
@@ -138,7 +138,7 @@ zpool \- configures ZFS storage pools
.LP
.nf
-\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...
+\fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR \fBu\fR | \fBd\fR ] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
.fi
.LP
@@ -669,6 +669,20 @@ is valid only while the system is up. Setting \fBaltroot\fR defaults to using
.sp
.LP
+The following property can be set only at import time:
+.sp
+.ne 2
+.na
+\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
+.ad
+.sp .6
+.RS 4n
+If set to \fBon\fR, the pool will be imported in read-only mode. This
+property can also be referred to by its shortened column name, \fBrdonly\fR.
+.RE
+
+.sp
+.LP
The following properties can be set at creation time and import time, and later
changed with the \fBzpool set\fR command:
.sp
@@ -1234,7 +1248,7 @@ Lists destroyed pools only.
.na
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR
\fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
-[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR
+[\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR\fR
.ad
.sp .6
.RS 4n
@@ -1306,6 +1320,19 @@ Forces import, even if the pool appears to be potentially active.
.sp
.ne 2
.na
+\fB\fB-F\fR\fR
+.ad
+.RS 21n
+Recovery mode for a non-importable pool. Attempt to return the pool to an importable
+state by discarding the last few transactions. Not all damaged pools can be recovered
+by using this option. If successful, the data from the discarded transactions is
+irretrievably lost. This option is ignored if the pool is importable or already
+imported.
+.RE
+
+.sp
+.ne 2
+.na
\fB\fB-a\fR\fR
.ad
.RS 21n
@@ -1315,6 +1342,16 @@ Searches for and imports all pools found.
.sp
.ne 2
.na
+\fB\fB-m\fR\fR
+.ad
+.RS 21n
+Allows a pool to import when there is a missing log device. Recent transactions
+can be lost because the log device will be discarded.
+.RE
+
+.sp
+.ne 2
+.na
\fB\fB-R\fR \fIroot\fR\fR
.ad
.RS 21n
@@ -1322,6 +1359,26 @@ Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR"
property to "\fIroot\fR".
.RE
+.sp
+.ne 2
+.na
+\fB\fB-N\fR\fR
+.ad
+.RS 21n
+Import the pool without mounting any file systems.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fB-n\fR\fR
+.ad
+.RS 21n
+Used with the \fB-F\fR recovery option. Determines whether a non-importable pool can be made
+importable again, but does not actually perform the pool recovery. For more details about pool
+recovery mode, see the \fB-F\fR option, above.
+.RE
+
.RE
.sp
@@ -1329,7 +1386,7 @@ property to "\fIroot\fR".
.na
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR
\fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
-[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR
+[\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR | \fIid\fR
[\fInewpool\fR]\fR
.ad
.sp .6
@@ -1412,6 +1469,19 @@ Forces import, even if the pool appears to be potentially active.
.sp
.ne 2
.na
+\fB\fB-F\fR\fR
+.ad
+.sp .6
+.RS 4n
+Recovery mode for a non-importable pool. Attempt to return the pool to an importable
+state by discarding the last few transactions. Not all damaged pools can be recovered
+by using this option. If successful, the data from the discarded transactions is
+irretrievably lost. This option is ignored if the pool is importable or already imported.
+.RE
+
+.sp
+.ne 2
+.na
\fB\fB-R\fR \fIroot\fR\fR
.ad
.sp .6
@@ -1420,6 +1490,29 @@ Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR"
property to "\fIroot\fR".
.RE
+.sp
+.ne 2
+.na
+\fB\fB-n\fR\fR
+.ad
+.sp .6
+.RS 4n
+Used with the \fB-F\fR recovery option. Determines whether a non-importable pool can be made
+importable again, but does not actually perform the pool recovery. For more details about pool
+recovery mode, see the \fB-F\fR option, above.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fB-m\fR\fR
+.ad
+.sp .6
+.RS 4n
+Allows a pool to import when there is a missing log device. Recent transactions
+can be lost because the log device will be discarded.
+.RE
+
.RE
.sp
@@ -1665,7 +1758,7 @@ more information on what properties can be set and acceptable values.
.sp
.ne 2
.na
-\fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR
+\fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR \fBu\fR | \fBd\fR ] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
.ad
.sp .6
.RS 4n
@@ -1722,7 +1815,7 @@ to enable all features on all pools.
.sp .6
.RS 4n
Displays legacy \fBZFS\fR versions supported by the current software. See
-\fBzfs-features\fR(5) for a description of feature flags features supported
+\fBzpool-features\fR(5) for a description of feature flags features supported
by the current software.
.RE
@@ -1735,7 +1828,7 @@ by the current software.
.RS 4n
Enables all supported features on the given pool. Once this is done, the
pool will no longer be accessible on systems that do not support feature
-flags. See \fBzfs-features\fR(5) for details on compatability with systems
+flags. See \fBzpool-features\fR(5) for details on compatibility with systems
that support feature flags, but do not support all features enabled on the
pool.
.sp
@@ -2075,7 +2168,7 @@ The command to remove the mirrored log \fBmirror-2\fR is:
.LP
The following command dipslays the detailed information for the \fIdata\fR
pool. This pool is comprised of a single \fIraidz\fR vdev where one of its
-devices increased its capacity by 1GB. In this example, the pool will not
+devices increased its capacity by 1GB. In this example, the pool will not
be able to utilized this extra capacity until all the devices under the
\fIraidz\fR vdev have been expanded.