A dataset can be one of the following:
.sp
.ne 2
-.mk
.na
-\fB\fIfile system\fR\fR
+\fB\fIfilesystem\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fIvolume\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fIsnapshot\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fIbookmark\fR\fR
.ad
Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups.
.sp
Unless necessary, deduplication should NOT be enabled on a system. Instead, consider using \fIcompression=lz4\fR, as a less resource-intensive alternative.
-.SS "Native Properties"
+.SS "Properties"
+.sp
.LP
-Properties are divided into two types, native properties and user-defined (or "user") properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR behavior, but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the "User Properties" section, below.
+Properties are divided into two types: native properties and user-defined (or "user") properties. Native properties either export internal statistics or control \fBZFS\fR behavior. User properties have no effect on \fBZFS\fR behavior, but you can use them to annotate datasets and snapshots in a way that is meaningful in your environment.
.sp
.LP
-Every dataset has a set of properties that export statistics about the dataset as well as control various behaviors. Properties are inherited from the parent unless overridden by the child. Some properties apply only to certain types of datasets (file systems, volumes, or snapshots).
+Properties are generally inherited from the parent unless overridden by the child. See the documentation below for exceptions.
+.sp
+.LP
+.SS "Native Properties"
+Native properties apply to all dataset types unless otherwise noted. However, native properties cannot be edited on snapshots.
.sp
.LP
-The values of numeric properties can be specified using human-readable abbreviations (\fBK\fR, \fBM\fR, \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, and \fBZ\fR). These abbreviations can optionally use the IEC binary prefixes (e.g. GiB) or SI decimal prefixes (e.g. GB), though the SI prefixes are treated as binary prefixes. Abbreviations are case-insensitive. The following are all valid (and equal) specifications:
+The values of numeric native properties can be specified using human-readable abbreviations (\fBK\fR, \fBM\fR, \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, and \fBZ\fR). These abbreviations can optionally use the IEC binary prefixes (e.g. GiB) or SI decimal prefixes (e.g. GB), though the SI prefixes are treated as binary prefixes. Abbreviations are case-insensitive. The following are all valid (and equal) specifications:
.sp
.in +2
.nf
.sp
.LP
-The values of non-numeric properties are case sensitive and must be lowercase, except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
+The values of non-numeric native properties are case-sensitive and must be lowercase, except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
.sp
.LP
-The following native properties consist of read-only statistics about the dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted.
+The following native properties consist of read-only statistics about the dataset. These properties can be neither set, nor inherited.
.sp
.ne 2
-.mk
.na
\fB\fBavailable\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBcompressratio\fR\fR
.ad
.sp .6
.RS 4n
-For non-snapshots, the compression ratio achieved for the \fBused\fR space of this dataset, expressed as a multiplier. The \fBused\fR property includes descendant datasets, and, for clones, does not include the space shared with the origin snapshot. For snapshots, the \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property. Compression can be turned on by running: \fBzfs set compression=on \fIdataset\fR\fR. The default value is \fBoff\fR.
+For non-snapshots, the compression ratio achieved for the \fBused\fR space of this dataset, expressed as a multiplier. The \fBused\fR property includes descendant datasets, and, for clones, does not include the space shared with the origin snapshot. For snapshots, the \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property. The \fBcompression\fR property controls whether compression is enabled on a dataset.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBcreation\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBclones\fR\fR
.ad
For snapshots, this property is a comma-separated list of filesystems or
volumes which are clones of this snapshot. The clones' \fBorigin\fR property
is this snapshot. If the \fBclones\fR property is not empty, then this
-snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options).
+snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options). The
+roles of origin and clone can be swapped by promoting the clone with the
+\fBzfs promote\fR command.
.RE
.sp
.sp
.ne 2
-.mk
.na
\fB\fBfilesystem_count\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBorigin\fR\fR
.ad
.sp .6
.RS 4n
-For cloned file systems or volumes, the snapshot from which the clone was created. See also the \fBclones\fR property.
+For cloned file systems or volumes, the snapshot from which the clone was created. The origin cannot be destroyed (even with the \fB-r\fR or \fB-f\fR options) so long as a clone exists. See also the \fBclones\fR property.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBreferenced\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBrefcompressratio\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBsnapshot_count\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBused\fR\fR
.ad
.sp
When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
.sp
-The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(2) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
+The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(2) or \fBO_SYNC\fR (see \fBopen\fR(2)) does not necessarily guarantee that the space usage information is updated immediately.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBusedby*\fR\fR
.ad
.sp .6
.RS 4n
-The \fBusedby*\fR properties decompose the \fBused\fR properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on \fBzpool\fR "version 13" pools.
+The \fBusedby*\fR properties decompose the \fBused\fR properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR + \fBusedbysnapshots\fR. These properties are only available for datasets created on \fBzpool\fR version 13 or higher pools.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBusedbychildren\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBusedbydataset\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBusedbyrefreservation\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBusedbysnapshots\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBuserused@\fR\fIuser\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBuserrefs\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBgroupused@\fR\fIgroup\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBvolblocksize\fR=\fIblocksize\fR\fR
.ad
The following native properties can be used to change the behavior of a \fBZFS\fR dataset.
.sp
.ne 2
-.mk
.na
-\fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
+\fB\fBaclinherit\fR=\fBrestricted\fR | \fBdiscard\fR | \fBnoallow\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBacltype\fR=\fBnoacl\fR | \fBposixacl\fR \fR
+\fB\fBacltype\fR=\fBoff\fR | \fBnoacl\fR | \fBposixacl\fR \fR
.ad
.sp .6
.RS 4n
Controls whether ACLs are enabled and if so what type of ACL to use. When
-a file system has the \fBacltype\fR property set to \fBnoacl\fR (the default)
+a file system has the \fBacltype\fR property set to \fBoff\fR (the default)
then ACLs are disabled. Setting the \fBacltype\fR property to \fBposixacl\fR
indicates Posix ACLs should be used. Posix ACLs are specific to Linux and
are not functional on other platforms. Posix ACLs are stored as an xattr and
Posix ACL being stored more efficiently on disk. But as a consequence of this
all new xattrs will only be accessible from ZFS implementations which support
the \fBxattr=sa\fR property. See the \fBxattr\fR property for more details.
+.sp
+The value \fBnoacl\fR is an alias for \fBoff\fR.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR
+\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR | \fBsha256\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBlz4\fR |
+\fB\fBcompression\fR=\fBoff\fR | \fBon\fR | \fBlzjb\fR | \fBlz4\fR |
\fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR\fR
.ad
.sp .6
.sp
.ne 2
-.mk
.na
\fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
.ad
.RS 4n
Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or RAID-Z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated file and dataset, changing the \fBused\fR property and counting against quotas and reservations.
.sp
-Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the \fB-o\fR \fBcopies=\fR\fIN\fR option.
+Changing this property only affects newly-written data.
+.sp
+Remember that \fBZFS\fR will not import a pool with a missing top-level vdev. Do NOT create, for example, a two-disk, striped pool and set \fBcopies=\fR\fI2\fR on some datasets thinking you have setup redundancy for them. When one disk dies, you will not be able to import the pool and will have lost all of your data.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBdedup\fR=\fBon\fR | \fBoff\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR
+\fB\fBdedup\fR=\fBoff\fR | \fBon\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBmlslabel\fR=\fIlabel\fR | \fBnone\fR\fR
+\fB\fBmlslabel\fR=\fBnone\fR\fR | \fIlabel\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBfilesystem_limit\fR=\fIcount\fR | \fBnone\fR\fR
+\fB\fBfilesystem_limit\fR=\fBnone\fR\fR | \fIcount\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBnbmand\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBquota\fR=\fBnone\fR | \fIsize\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBsnapshot_limit\fR=\fIcount\fR | \fBnone\fR\fR
+\fB\fBsnapshot_limit\fR=\fBnone\fR\fR | \fIcount\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
.na
-\fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBuserquota@\fR\fIuser\fR=\fBnone\fR | \fIsize\fR\fR
.ad
.sp .6
.RS 4n
-Limits the amount of space consumed by the specified user. Similar to the \fBrefquota\fR property, the \fBuserquota\fR space calculation does not include space that is used by descendent datasets, such as snapshots and clones. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
+Limits the amount of space consumed by the specified user. Similar to the \fBrefquota\fR property, the \fBuserquota\fR space calculation does not include space that is used by descendent datasets, such as snapshots and clones. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property. See the \fBzfs userspace\fR subcommand for more information.
.sp
-Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed their quota before the system notices that they are over quota and begins to refuse additional writes with the \fBEDQUOT\fR error message . See the \fBzfs userspace\fR subcommand for more information.
+Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed their quota before the system notices that they are over quota and begins to refuse additional writes with the \fBEDQUOT\fR error message.
.sp
Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs allow\fR, can get and set everyone's quota.
.sp
.sp
.ne 2
-.mk
.na
-\fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBgroupquota@\fR\fIgroup\fR=\fBnone\fR\fR | \fIsize\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBreadonly\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBrecordsize\fR=\fIsize\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBredundant_metadata\fR=\fBall\fR | \fBmost\fR\fR
.ad
.sp
.ne 2
.na
-\fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBrefquota\fR=\fBnone\fR | \fIsize\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBrefreservation\fR=\fBnone\fR | \fIsize\fR\fR
.ad
.sp .6
.RS 4n
The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
.sp
-If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset.
+If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of \fBreferenced\fR bytes in the dataset (which are the bytes to be referenced by the snapshot). This is necessary to continue to provide the \fBrefreservation\fRguarantee to the dataset.
+.sp
+For volumes, see also \fBvolsize\fR.
.sp
This property can also be referred to by its shortened column name, \fBrefreserv\fR.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBrelatime\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBrelatime\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
+\fB\fBreservation\fR=\fBnone\fR | \fIsize\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR
+\fB\fBsharesmb\fR=\fBoff\fR | \fBon\fR
.ad
.sp .6
.RS 4n
Controls whether the file system is shared by using \fBSamba USERSHARES\fR, and what options are to be used. Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBnet\fR(8) command is invoked to create a \fBUSERSHARE\fR.
.sp
-Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be illegal in the resource name, are replaced with underscore (\fB_\fR) characters. The ZFS On Linux driver does not (yet) support additional options which might be available in the Solaris version.
+Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be invalid in the resource name, are replaced with underscore (\fB_\fR) characters. Linux does not currently support additional options which might be available on Solaris.
.sp
If the \fBsharesmb\fR property is set to \fBoff\fR, the file systems are unshared.
.sp
-In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ("F" stands for "full permissions", ie. read and write permissions) and no guest access (which means samba must be able to authenticate a real user, system passwd/shadow, ldap or smbpasswd based) by default. This means that any additional access control (disallow specific user specific access etc) must be done on the underlaying filesystem.
+In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ("F" stands for "full permissions", ie. read and write permissions) and no guest access (which means Samba must be able to authenticate a real user, system passwd/shadow, LDAP or smbpasswd based) by default. This means that any additional access control (disallow specific user specific access etc) must be done on the underlaying filesystem.
.sp
.in +2
Example to mount a SMB filesystem shared through ZFS (share/tmp):
-.mk
Note that a user and his/her password \fBmust\fR be given!
.sp
.in +2
.in -2
.sp
.ne 2
-.mk
.na
\fBMinimal /etc/samba/smb.conf configuration\fR
.sp
.in +2
-* Samba will need to listen to 'localhost' (127.0.0.1) for the zfs utilities to communitate with samba. This is the default behavior for most Linux distributions.
+* Samba will need to listen to 'localhost' (127.0.0.1) for the zfs utilities to communicate with Samba. This is the default behavior for most Linux distributions.
.sp
* Samba must be able to authenticate a user. This can be done in a number of ways, depending on if using the system password file, LDAP or the Samba specific smbpasswd file. How to do this is outside the scope of this manual. Please refer to the smb.conf(5) manpage for more information.
.sp
.sp
.ne 2
-.mk
.na
-\fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
+\fB\fBsharenfs\fR=\fBoff\fR | \fBon\fR | \fIopts\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
+\fB\fBlogbias\fR=\fBlatency\fR | \fBthroughput\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBsnapdev\fR=\fBhidden\fR | \fBvisible\fR\fR
.ad
.sp .6
.RS 4n
Controls whether the snapshots devices of zvol's are hidden or visible. The default value is \fBhidden\fR.
+.sp
+In this context, hidden does not refer to the concept of hiding files or directories by starting their name with a "." character. Even with \fBvisible\fR, the directory is still named \fB\&.zfs\fR. Instead, \fBhidden\fR means that the directory is not returned by \fBreaddir\fR(3), so it doesn't show up in directory listings done by any program, including \fBls\fR \fB-a\fR. It is still possible to chdir(2) into the directory, so \fBcd\fR \fB\&.zfs\fR works even with \fBhidden\fR. This unusual behavior is to protect against unwanted effects from applications recursing into the special \fB\&.zfs\fR directory.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBsync\fR=\fBstandard\fR | \fBalways\fR | \fBdisabled\fR\fR
.ad
.sp
.ne 2
.na
-\fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
+\fB\fBversion\fR=\fB5\fR | \fB4\fR | \fB3\fR | \fB2\fR | \fB1\fR | \fBcurrent\fR\fR
.ad
.sp .6
.RS 4n
-The on-disk version of this file system, which is independent of the pool version. This property can only be set to later supported versions. See the \fBzfs upgrade\fR command.
+The on-disk version of this file system, which is independent of the pool version. This property can only be set to later supported versions. The value \fBcurrent\fR automatically selects the latest supported version. See the \fBzfs upgrade\fR command.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBvolsize\fR=\fIsize\fR\fR
.ad
.sp .6
.RS 4n
-For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
+For volumes, specifies the logical size of the volume. By default, creating a volume establishes a \fBrefreservation\fR equal to the volume size plus the metadata required for a fully-written volume. (For pool version 8 or lower, a \fBreservation\fR is set instead.) Any changes to \fBvolsize\fR are reflected in an equivalent change to the \fBrefreservation\fR. The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
.sp
-The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
+Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
.sp
-Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
+A "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR command, or by removing (or changing) the \fBrefreservation\fR after the volume has been created. A "sparse volume" is a volume where the \fBrefreservation\fR is unset or less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBvscan\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBxattr\fR=\fBon\fR | \fBoff\fR | \fBsa\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBzoned\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the \fBzfs create\fR or \fBzpool create\fR commands, these properties are inherited from the parent dataset. If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties.
.sp
.ne 2
-.mk
.na
\fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR
.ad
.sp .6
.RS 4n
-Indicates whether the file system should perform a \fBunicode\fR normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison process. If this property is set to a legal value other than \fBnone\fR, and the \fButf8only\fR property was left unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The default value of the \fBnormalization\fR property is \fBnone\fR. This property cannot be changed after the file system is created.
+Indicates whether the file system should perform a Unicode normalization of file names whenever two file names are compared, and which normalization algorithm should be used.
+.sp
+If this property is set to a value other than \fBnone\fR (the default), and the \fButf8only\fR property was left unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. See the cautionary note in the \fButf8only\fR section before modifying \fBnormalization\fR.
+.sp
+File names are always stored unmodified; names are normalized as part of any comparison process. Thus, \fBformC\fR and \fBformD\fR are equivalent, as are \fBformKC\fR and \fBformKD\fR. Given that, only \fBformD\fR and \fBformKD\fR make sense, as they are slightly faster because they avoid the additional canonical composition step.
+.\" unicode.org says it's possible to quickly detect if a string is already in a given form. Since most text (basically everything but OS X) is already in NFC, this means formC could potentially be made faster. But the additional complexity probably isn't worth the likely undetectable in practice speed improvement.
+.sp
+The practical impact of this property is: \fBnone\fR (like traditional filesystems) allows a directory to contain two files that appear (to humans) to have the same name. The other options solve this problem, for different definitions of "the same". If you need to solve this problem and are not sure what to choose,\fBformD\fR.
+.sp
+This property cannot be changed after the file system is created.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fButf8only\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
-Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to \fBoff\fR, the normalization property must either not be explicitly set or be set to \fBnone\fR. The default value for the \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the file system is created.
+Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character set. If this property is explicitly set to \fBoff\fR, the \fBnormalization\fR property must either not be explicitly set or be set to \fBnone\fR. The default value for the \fButf8only\fR property is \fBoff\fR.
+.sp
+Note that forcing the use of \fBUTF-8\fR filenames may cause pain for users. For example, extracting files from an archive will fail if the filenames within the archive are encoded in another character set.
+.sp
+If you are thinking of setting this (to \fBon\fR), you probably want to set \fBnormalization\fR=\fBformD\fR which will set this property to \fBon\fR implicitly.
+.sp
+This property cannot be changed after the file system is created.
.RE
.sp
.LP
-The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
+The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties are also permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBcontext\fR=\fBSELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
+\fB\fBcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
.ad
.sp .6
.RS 4n
-This flag sets the SELinux context for all files in the filesytem under the mountpoint for that filesystem. See \fBselinux\fR(8) for more information.
+This flag sets the SELinux context for all files in the filesystem under the mountpoint for that filesystem. See \fBselinux\fR(8) for more information.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBfscontext\fR=\fBSELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
+\fB\fBfscontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
.ad
.sp .6
.RS 4n
-This flag sets the SELinux context for the filesytem being mounted. See \fBselinux\fR(8) for more information.
+This flag sets the SELinux context for the filesystem being mounted. See \fBselinux\fR(8) for more information.
.RE
.sp
.ne 2
-.mk
.na
-\fB\fBdefntext\fR=\fBSELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
+\fB\fBdefcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBrootcontext\fR=\fBSELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
+\fB\fBrootcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
-\fB\fBoverlay\fR=\fBon\fR | \fBoff\fR\fR
+\fB\fBoverlay\fR=\fBoff\fR | \fBon\fR\fR
.ad
.sp .6
.RS 4n
In addition, these options can be set on a per-mount basis using the \fB-o\fR option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties are reported as "temporary" by the \fBzfs get\fR command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
.SS "User Properties"
.LP
-In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
+In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots). Unlike native properties, user properties are editable on snapshots.
.sp
.LP
User property names must contain a colon (\fB:\fR) character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the property name is divided into two portions such as \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash (\fB-\fR).
.sp
.LP
-When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. For example, property names beginning with \fBcom.sun\fR. are reserved for use by Oracle Corporation (which acquired Sun Microsystems).
+When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. For example, property names beginning with \fBcom.sun\fR. are reserved for definition by Oracle Corporation (which acquired Sun Microsystems).
.sp
.LP
-The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (\fBzfs list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate both native properties and user properties. Use the \fBzfs inherit\fR command to clear a user property . If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
+The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (\fBzfs list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate both native properties and user properties. Use the \fBzfs inherit\fR command to clear a user property. If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
.SS "ZFS Volumes as Swap"
.LP
\fBZFS\fR volumes may be used as Linux swap devices. After creating the volume
\fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
.SH SUBCOMMANDS
.LP
-All subcommands that modify state are logged persistently to the pool in their original form.
+All subcommands that modify state are logged persistently to the pool in their original form. The log can be viewed with \fBzpool history\fR.
.sp
.ne 2
-.mk
.na
\fB\fBzfs ?\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR\fR
.ad
.sp .6
.RS 4n
-Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR property inherited from the parent.
+Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR and \fBcanmount\fR properties.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp .6
.RS 4n
-Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
+Creates all the non-existing parent datasets. Datasets created in this manner inherit their properties; any property specified on the command line using the \fB-o\fR option applies only to the final child file system. If the target filesystem already exists, the operation completes successfully and no properties are changed.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
.ad
.sp .6
.RS 4n
-Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/\fR\fIpath\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents the logical size as exported by the device. By default, a reservation of equal size is created.
+Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/\fR\fIpath\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents the logical size as exported by the device. By default, a \fBrefreservation\fR is created.
.sp
\fIsize\fR is automatically rounded up to the nearest 128KiB to ensure that the volume has an integral number of blocks regardless of \fIblocksize\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp .6
.RS 4n
-Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
+Creates all the non-existing parent datasets as file systems. Datasets created in this manner inherit their properties; any property specified on the command line using the \fB-o\fR option applies only to the final child volume. If the target volume already exists, the operation completes successfully and no properties are changed.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR\fR
.ad
.sp .6
.RS 4n
-Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native Properties section for more information about sparse volumes.
+Creates a sparse volume by omitting the automatic creation of a \fBrefreservation\fR. See \fBvolsize\fR in the Native Properties section for more information about sparse volumes. If this option is specified in conjunction with \fB-o\fR \fBrefreservation\fR, the \fBrefreservation\fR will be honored; this allows for a partial reservation on a sparse volume.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
.sp .6
.RS 4n
Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR command was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
+.sp
+If \fB-o\fR \fBvolsize\fR is provided, the resulting behavior is undefined; it conflicts with the -V option, which is required in this mode.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-b\fR \fIblocksize\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
.ad
Destroys the given dataset. By default, the command unshares any file systems that are currently shared, unmounts any file systems that are currently mounted, and refuses to destroy a dataset that has active dependents (children or clones).
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-f\fR\fR
.ad
.sp .6
.RS 4n
-Force an unmount of any file systems using the \fBunmount -f\fR command. This option has no effect on non-file systems or unmounted file systems.
+Force an unmount of any file systems using the \fBzfs unmount -f\fR command. This option has no effect on non-file systems or unmounted file systems.
.RE
.sp
.RE
.sp
-Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use.
+Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR options, as they can destroy large portions of a pool.
.RE
.sp
.ne 2
-.mk
.na
\fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...]
.ad
.sp .6
.RS 4n
-The given snapshots are destroyed immediately if and only if the \fBzfs destroy\fR command without the \fB-d\fR option would have destroyed it. Such immediate destruction would occur, for example, if the snapshot had no clones and the user-initiated reference count were zero.
-.sp
-If a snapshot does not qualify for immediate destruction, it is marked for deferred destruction. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed.
+The specified snapshots are destroyed immediately if they have no clones and the user-initiated reference count is zero (i.e. there are no holds set with \fBzfs hold\fR). If these conditions are not met, this command returns an error, unless \fB-d\fR is supplied.
.sp
An inclusive range of snapshots may be specified by separating the
first and last snapshots with a percent sign.
comma-separated list to identify multiple snapshots.
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR\fR
.ad
.sp .6
.RS 4n
-Defer snapshot deletion.
+If a snapshot does not qualify for immediate destruction, rather than returning an error, it is marked for deferred destruction. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fBzfs destroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR
.ad
Creates snapshots with the given names. All previous modifications by successful system calls to the file system are part of the snapshots. Snapshots are taken atomically, so that all snapshots correspond to the same moment in time. See the "Snapshots" section for details.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
.sp .6
.RS 4n
-Sets the specified property; see \fBzfs create\fR for details.
+Sets the specified property; see \fBzfs set\fR for details.
.RE
.RE
.sp
.ne 2
-.mk
.na
\fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
.ad
The \fB-rR\fR options do not recursively destroy the child snapshots of a recursive snapshot. Only direct snapshots of the specified filesystem are destroyed by either of these options. To completely roll back a recursive snapshot, you must rollback the individual child snapshots.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-f\fR\fR
.ad
.sp .6
.RS 4n
-Used with the \fB-R\fR option to force an unmount of any clone file systems that are to be destroyed.
+Used with the \fB-R\fR option to force an unmount (see \fBzfs unmount -f\fR) of any clone file systems that are to be destroyed.
.RE
.RE
.sp
.ne 2
-.mk
.na
\fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
.ad
Creates a clone of the given snapshot. See the "Clones" section for details. The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is created as the same type as the original.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp .6
.RS 4n
-Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
+Creates all the non-existing parent datasets; see \fBzfs create\fR for details.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
.sp .6
.RS 4n
-Sets the specified property; see \fBzfs create\fR for details.
+Sets the specified property; see \fBzfs set\fR for details.
.RE
.RE
.sp
.ne 2
-.mk
.na
\fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
.ad
.RS 4n
Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the origin file system becomes a clone of the specified file system.
.sp
-The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the origin file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The \fBrename\fR subcommand can be used to rename any conflicting snapshots.
+The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the origin file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The \fBzfs rename\fR command can be used to rename any conflicting snapshots.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
.ad
.br
.na
-\fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
-.ad
-.br
-.na
\fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp .6
Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp .6
.RS 4n
-Creates all the nonexistent parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent.
+Creates all the nonexistent parent datasets; see \fBzfs create\fR for details.
.RE
.sp
.sp
.ne 2
-.mk
.na
\fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR|\fImountpoint\fR] ...\fR
.ad
.sp .6
.RS 4n
-Lists the property information for the given datasets in tabular form. If a mount point is specified, it can be an absolute pathname or a relative pathname as long as it contains a slash (e.g. \fBzfs list ./\fR). By default, all file systems and volumes are displayed. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the default is \fBoff\fR). When listing hundreds or thousands of snapshots performance can be improved by restricting the output to only the name. In that case, it is recommended to use \fB-o name -s name\fR. The following fields are displayed by default, \fBname,used,available,referenced,mountpoint\fR
+Lists the property information for the given datasets in tabular form. If a mount point is specified, it can be an absolute pathname or a relative pathname starting with "./" (e.g. \fBzfs list ./\fR). By default, all file systems and volumes are displayed. Snapshots are displayed if the pool's \fBlistsnapshots\fR property is \fBon\fR (the default is \fBoff\fR). When listing hundreds or thousands of snapshots performance can be improved by restricting the output to only the name. In that case, it is recommended to use \fB-o name -s name\fR. The following fields are displayed by default: \fBname, used, available, referenced, mountpoint\fR
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.sp .6
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR \fIdepth\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIproperty\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR \fIproperty\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-S\fR \fIproperty\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR \fItype\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR[ \fIproperty\fR=\fIvalue\fR]...
\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
.sp
.ne 2
-.mk .na
\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
.ad
.sp .6
The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume snapshot, or bookmark).
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR \fIdepth\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIfield\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR \fIsource\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs inherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
.ad
Clears the specified property, causing it to be inherited from an ancestor, restored to default if no ancestor has the property set, or with the \fB-S\fR option reverted to the received value if one exists. See the "Properties" section for a listing of default values, and details on which properties can be inherited.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBzfs upgrade\fR [\fB-v\fR]\fR
+\fB\fBzfs upgrade\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
+.na
+\fB\fBzfs upgrade\fR \fB-v\fR\fR
+.ad
+.sp .6
+.RS 4n
+Displays a list of file system versions.
+.RE
+
+
+.sp
+.ne 2
.na
\fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR
.ad
In some cases, the file system version and the pool version are interrelated and the pool version must be upgraded before the file system version can be upgraded.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
.sp .6
.RS 4n
-Upgrade all file systems on all imported pools.
+Upgrades all file systems on all imported pools.
.RE
.sp
.ne 2
-.mk
.na
\fB\fIfilesystem\fR\fR
.ad
.sp .6
.RS 4n
-Upgrade the specified file system.
+Upgrades the specified file system.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp .6
.RS 4n
-Upgrade the specified file system and all descendent file systems
+Upgrades the specified file system and all descendent file systems
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-V\fR \fIversion\fR\fR
.ad
.sp .6
.RS 4n
-Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
+Upgrades to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
.RE
.RE
.sp
.ne 2
-.mk
.na
\fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]]
[\fB-s\fR \fIfield\fR] ...
\fBuserquota@\fR\fIuser\fR properties.
.sp
.ne 2
-.mk
.na
\fB\fB-n\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR\fR
.ad
.sp .6
.RS 4n
-Do not print headers, use tab-delimited output.
+Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIfield\fR[,...]\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR \fIfield\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-S\fR \fIfield\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR \fItype\fR[,...]\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-i\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]]
[\fB-s\fR \fIfield\fR] ...
.sp
.ne 2
-.mk
.na
\fB\fBzfs mount\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR | \fIfilesystem\fR\fR
.ad
.sp .6
.RS 4n
-Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot process.
+Mounts \fBZFS\fR file systems. This is invoked automatically as part of the boot process.
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIoptions\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-O\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-v\fR\fR
.ad
.sp .6
.RS 4n
-Report mount progress.
+Report mount progress. This is intended for use with \fBzfs mount -a\fR on a system with a significant number of filesystems.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fIfilesystem\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
.ad
Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as part of the shutdown process.
.sp
.ne 2
-.mk
.na
\fB\fB-f\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fIfilesystem\fR|\fImountpoint\fR\fR
+\fIfilesystem\fR|\fImountpoint\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
.ad
Shares available \fBZFS\fR file systems.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fIfilesystem\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
.ad
Unshares currently shared \fBZFS\fR file systems. This is invoked automatically as part of the shutdown process.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs bookmark\fR \fIsnapshot\fR \fIbookmark\fR\fR
.ad
.ad
.sp .6
.RS 4n
-Creates a stream representation of the second \fIsnapshot\fR, which is written to standard output. The output can be redirected to a file or to a different system (for example, using \fBssh\fR(1). By default, a full stream is generated.
+Creates a stream representation of the (second, if \fB-i\fR is specified) \fIsnapshot\fR, which is written to standard output. The output can be redirected to a file or to a pipe (for example, using \fBssh\fR(1) to send it to a different system with \fBzfs receive\fR). By default, a full stream is generated; specifying \fB-i\fR or \fB-I\fR changes this behavior.
.sp
.ne 2
-.mk
.na
\fB\fB-i\fR \fIsnapshot\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-I\fR \fIsnapshot\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-D\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-L\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-e\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-v\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-L\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-e\fR\fR
.ad
.RE
.sp
.ne 2
-.mk
.na
\fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-o origin\fR=\fIsnapshot\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
.ad
.sp
If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For \fBzvols\fR, the destination device link is destroyed and recreated, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
.sp
-When a snapshot replication package stream that is generated by using the \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command.
+When a snapshot replication package stream that is generated by using the \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command.
.sp
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the use of the \fB-d\fR or \fB-e\fR options.
.sp
The \fB-d\fR and \fB-e\fR options cause the file system name of the target snapshot to be determined by appending a portion of the sent snapshot's name to the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all but the first element of the sent snapshot's file system path (usually the pool name) is used and any required intermediate file systems within the specified one are created. If the \fB-e\fR option is specified, then only the last element of the sent snapshot's file system name (i.e. the name of the source file system itself) is used as the target file system name.
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-u\fR\fR
.ad
.sp .6
.RS 4n
-File system that is associated with the received stream is not mounted.
+Do not mount the file system that is associated with the received stream.
.RE
.sp
.sp
.ne 2
-.mk
.na
\fB\fB-n\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fBorigin\fR=\fIsnapshot\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB-F\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR
.ad
Delegates \fBZFS\fR administration permission for the file systems to non-privileged users.
.sp
.ne 2
-.mk
.na
\fB[\fB-ug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...]\fR
.ad
.sp
.ne 2
-.mk
.na
\fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR
.ad
.sp
.ne 2
-.mk
.na
\fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp
.LP
-Permissions are generally the ability to use a \fBZFS\fR subcommand or change a \fBZFS\fR property. The following permissions are available:
+Permissions are generally the ability to use a \fBzfs\fR subcommand or change a property. The following permissions are available:
.sp
.in +2
.nf
.sp
.ne 2
-.mk
.na
\fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[, ...]] \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.ad
.br
.na
-\fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
-.ad
-.br
-.na
-\fB\fIfilesystem\fR|\fIvolume\fR\fR
+\fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR \fB\fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp .6
.RS 4n
Removes permissions that were granted with the \fBzfs allow\fR command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified, then all permissions for the specified \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the \fBzfs allow\fR command for a description of the \fB-ldugec\fR options.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
-\fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
-.ad
-.br
-.na
-\fB\fIfilesystem\fR|\fIvolume\fR\fR
+\fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR \fB\fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp .6
.RS 4n
.sp
.ne 2
-.mk
.na
\fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
.ad
If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
.ad
Lists all existing user references for the given snapshot or snapshots.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
.ad
.RS 4n
Removes a single reference, named with the \fItag\fR argument, from the specified snapshot or snapshots. The tag must already exist for each snapshot.
.sp
-If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
-.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
.ad
\fBExample 2 \fRCreating a ZFS Snapshot
.sp
.LP
-The following command creates a snapshot named \fByesterday\fR. This snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the \fBpool/home/bob\fR file system.
+The following command creates a snapshot named \fBbackup\fR. This snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the \fBpool/home/bob\fR file system.
.sp
.in +2
.nf
-# \fBzfs snapshot pool/home/bob@yesterday\fR
+# \fBzfs snapshot pool/home/bob@backup\fR
.fi
.in -2
.sp
\fBExample 3 \fRCreating and Destroying Multiple Snapshots
.sp
.LP
-The following command creates snapshots named \fByesterday\fR of \fBpool/home\fR and all of its descendent file systems. Each snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its file system. The second command destroys the newly created snapshots.
+The following command creates snapshots named \fBbackup\fR of \fBpool/home\fR and all of its descendent file systems. Each snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its file system. The second command destroys the newly created snapshots.
.sp
.in +2
.nf
-# \fBzfs snapshot -r pool/home@yesterday\fR
-# \fBzfs destroy -r pool/home@yesterday\fR
+# \fBzfs snapshot -r pool/home@backup\fR
+# \fBzfs destroy -r pool/home@backup\fR
.fi
.in -2
.sp
\fBExample 5 \fRListing ZFS Datasets
.sp
.LP
-The following command lists all active file systems and volumes in the system. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The default is \fBoff\fR. See \fBzpool\fR(8) for more information on pool properties.
+The following command lists all active file systems and volumes in the system. Snapshots are displayed if the pool's \fBlistsnapshots\fR property is \fBon\fR (the default is \fBoff\fR). See \fBzpool\fR(8) for more information on pool properties.
.sp
.in +2
The following exit values are returned:
.sp
.ne 2
-.mk
.na
\fB\fB0\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB1\fR\fR
.ad
.sp
.ne 2
-.mk
.na
\fB\fB2\fR\fR
.ad
projects / mirror_zfs.git / blobdiff