Document the "readonly" pool property

This documentation is based FreeBSD's zpool(8) man page. Signed-off-by: Tim Chase <[email protected]> Signed-off-by: Brian Behlendorf <[email protected]> Closes #2682
openzfs · Sep 9, 2014 · 52dd454 · 52dd454
1 parent 223df01
commit 52dd454
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/man/man8/zpool.8 b/man/man8/zpool.8
@@ -631,6 +631,24 @@ The following property can be set at creation time and import time:
 Alternate root directory. If set, this directory is prepended to any mount points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where the typical paths are not valid. \fBaltroot\fR is not a persistent property. It is valid only while the system is up. Setting \fBaltroot\fR defaults to using \fBcachefile\fR=none, though this may be overridden using an explicit setting.
 .RE
 
+.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: