summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorTim Chase <tim@chase2k.com>2014-09-09 07:23:29 -0500
committerBrian Behlendorf <behlendorf1@llnl.gov>2014-09-09 11:35:46 -0700
commit52dd454d05a14813ed74e93dfca6ac2994333c4d (patch)
tree07577049fa1aacd1e4871fbaa8a36e65de0b2c2b /man
parent223df0161fad50f53a8fa5ffeea8cc4f8137d522 (diff)
Document the "readonly" pool property
This documentation is based FreeBSD's zpool(8) man page. Signed-off-by: Tim Chase <tim@chase2k.com> Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #2682
Diffstat (limited to 'man')
-rw-r--r--man/man8/zpool.818
1 files changed, 18 insertions, 0 deletions
diff --git a/man/man8/zpool.8 b/man/man8/zpool.8
index 4f81a229a..f5b4bacd6 100644
--- a/man/man8/zpool.8
+++ b/man/man8/zpool.8
@@ -633,6 +633,24 @@ Alternate root directory. If set, this directory is prepended to any mount point
.sp
.LP
+The following property can only be set at import time:
+.sp
+.ne 2
+.mk
+.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: Synchronous data in the intent log will not be accessible, properties of the pool can not be changed and datasets of the pool can only be mounted read-only. The \fBreadonly\fR property of its datasets will be implicitly set to \fBon\fR.
+
+It can also be specified by its column name of \fBrdonly\fR.
+
+To write to a read-only pool, a export and import of the pool is required.
+.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
.ne 2