diff options
Diffstat (limited to 'usr/src/man/man1m/zfs.1m')
| -rw-r--r-- | usr/src/man/man1m/zfs.1m | 288 |
1 files changed, 68 insertions, 220 deletions
diff --git a/usr/src/man/man1m/zfs.1m b/usr/src/man/man1m/zfs.1m index dd343d7010..d1052c7d2c 100644 --- a/usr/src/man/man1m/zfs.1m +++ b/usr/src/man/man1m/zfs.1m @@ -8,7 +8,8 @@ .\" 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] .\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. -.TH zfs 1M "24 Sep 2009" "SunOS 5.11" "System Administration Commands" +.\" Copyright 2011 by Delphix. All rights reserved. +.TH ZFS 1M "Sep 24, 2009" .SH NAME zfs \- configures ZFS file systems .SH SYNOPSIS @@ -39,7 +40,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... +\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR .fi @@ -60,7 +61,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR +\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR .fi @@ -120,7 +121,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBmount\fR +\fBzfs\fR \fBmount\fR .fi .LP @@ -165,7 +166,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] +\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] \fIfilesystem\fR|\fIvolume\fR .fi @@ -186,7 +187,7 @@ zfs \- configures ZFS file systems .LP .nf -\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] +\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR .fi @@ -242,7 +243,6 @@ where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes). A dataset can be one of the following: .sp .ne 2 -.mk .na \fB\fIfile system\fR\fR .ad @@ -258,7 +258,6 @@ free space. .sp .ne 2 -.mk .na \fB\fIvolume\fR\fR .ad @@ -271,7 +270,6 @@ most environments. .sp .ne 2 -.mk .na \fB\fIsnapshot\fR\fR .ad @@ -443,7 +441,6 @@ dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted. .sp .ne 2 -.mk .na \fB\fBavailable\fR\fR .ad @@ -460,20 +457,22 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk .na \fB\fBcompressratio\fR\fR .ad .sp .6 .RS 4n -The compression ratio achieved for this dataset, expressed as a multiplier. +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. .RE .sp .ne 2 -.mk .na \fB\fBcreation\fR\fR .ad @@ -484,7 +483,6 @@ The time this dataset was created. .sp .ne 2 -.mk .na \fB\fBdefer_destroy\fR\fR .ad @@ -497,7 +495,6 @@ by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is .sp .ne 2 -.mk .na \fB\fBmounted\fR\fR .ad @@ -509,7 +506,6 @@ property can be either \fByes\fR or \fBno\fR. .sp .ne 2 -.mk .na \fB\fBorigin\fR\fR .ad @@ -522,7 +518,6 @@ options) so long as a clone exists. .sp .ne 2 -.mk .na \fB\fBreferenced\fR\fR .ad @@ -539,7 +534,18 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk +.na +\fB\fBrefcompressratio\fR\fR +.ad +.sp .6 +.RS 4n +The compression ratio achieved for the \fBreferenced\fR space of this +dataset, expressed as a multiplier. See also the \fBcompressratio\fR +property. +.RE + +.sp +.ne 2 .na \fB\fBtype\fR\fR .ad @@ -550,7 +556,6 @@ The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR. .sp .ne 2 -.mk .na \fB\fBused\fR\fR .ad @@ -580,7 +585,6 @@ immediately. .sp .ne 2 -.mk .na \fB\fBusedby*\fR\fR .ad @@ -595,7 +599,6 @@ on \fBzpool\fR "version 13" pools. .sp .ne 2 -.mk .na \fB\fBusedbychildren\fR\fR .ad @@ -607,7 +610,6 @@ all the dataset's children were destroyed. .sp .ne 2 -.mk .na \fB\fBusedbydataset\fR\fR .ad @@ -620,7 +622,6 @@ destroying any necessary snapshots or descendents). .sp .ne 2 -.mk .na \fB\fBusedbyrefreservation\fR\fR .ad @@ -632,7 +633,6 @@ would be freed if the \fBrefreservation\fR was removed. .sp .ne 2 -.mk .na \fB\fBusedbysnapshots\fR\fR .ad @@ -646,7 +646,6 @@ properties because space can be shared by multiple snapshots. .sp .ne 2 -.mk .na \fB\fBuserused@\fR\fIuser\fR\fR .ad @@ -692,7 +691,6 @@ following forms: .sp .ne 2 -.mk .na \fB\fBuserrefs\fR\fR .ad @@ -704,7 +702,6 @@ are set by using the \fBzfs hold\fR command. .sp .ne 2 -.mk .na \fB\fBgroupused@\fR\fIgroup\fR\fR .ad @@ -721,7 +718,6 @@ allow\fR, can access all groups' usage. .sp .ne 2 -.mk .na \fB\fBvolblocksize\fR=\fIblocksize\fR\fR .ad @@ -742,7 +738,6 @@ 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 @@ -771,7 +766,6 @@ mode from the application. .sp .ne 2 -.mk .na \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR .ad @@ -790,7 +784,6 @@ represent the new mode of the file or directory. .sp .ne 2 -.mk .na \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -804,7 +797,6 @@ and other similar utilities. The default value is \fBon\fR. .sp .ne 2 -.mk .na \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR .ad @@ -830,7 +822,6 @@ This property is not inherited. .sp .ne 2 -.mk .na \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR @@ -848,7 +839,6 @@ Changing this property affects only newly-written data. .sp .ne 2 -.mk .na \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR\fR @@ -870,7 +860,6 @@ This property can also be referred to by its shortened column name .sp .ne 2 -.mk .na \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR .ad @@ -889,7 +878,6 @@ property at file system creation time by using the \fB-o\fR .sp .ne 2 -.mk .na \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -901,7 +889,6 @@ value is \fBon\fR. .sp .ne 2 -.mk .na \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -913,7 +900,6 @@ default value is \fBon\fR. .sp .ne 2 -.mk .na \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR .ad @@ -933,7 +919,6 @@ new location. .sp .ne 2 -.mk .na \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -947,7 +932,6 @@ property only take effect when the file system is umounted and remounted. See .sp .ne 2 -.mk .na \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -962,7 +946,6 @@ is set to \fBmetadata\fR, then only metadata is cached. The default value is .sp .ne 2 -.mk .na \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -980,7 +963,6 @@ implicit quota. .sp .ne 2 -.mk .na \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1030,7 +1012,6 @@ displayed by \fBzfs get all\fR. The user's name must be appended after the .sp .ne 2 -.mk .na \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1046,7 +1027,6 @@ allow\fR, can get and set all groups' quotas. .sp .ne 2 -.mk .na \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1060,7 +1040,6 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk .na \fB\fBrecordsize\fR=\fIsize\fR\fR .ad @@ -1089,7 +1068,6 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk .na \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1102,7 +1080,6 @@ by descendents, including file systems and snapshots. .sp .ne 2 -.mk .na \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1125,7 +1102,6 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk .na \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR .ad @@ -1143,7 +1119,6 @@ This property can also be referred to by its shortened column name, .sp .ne 2 -.mk .na \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -1158,7 +1133,6 @@ value is \fBall\fR. .sp .ne 2 -.mk .na \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1170,7 +1144,6 @@ default value is \fBon\fR. .sp .ne 2 -.mk .na \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1189,7 +1162,6 @@ setting this property on a file system has no direct effect. .sp .ne 2 -.mk .na \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR .ad @@ -1228,7 +1200,6 @@ are unshared. .sp .ne 2 -.mk .na \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR .ad @@ -1252,7 +1223,6 @@ unshared. .sp .ne 2 -.mk .na \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR .ad @@ -1268,7 +1238,6 @@ efficient use of resources. .sp .ne 2 -.mk .na \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR .ad @@ -1281,7 +1250,6 @@ the file system as discussed in the "Snapshots" section. The default value is .sp .ne 2 -.mk .na \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR .ad @@ -1294,7 +1262,6 @@ version. This property can only be set to later supported versions. See the .sp .ne 2 -.mk .na \fB\fBvolsize\fR=\fIsize\fR\fR .ad @@ -1325,7 +1292,6 @@ reflected in the reservation. .sp .ne 2 -.mk .na \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1339,7 +1305,6 @@ service must also be enabled for virus scanning to occur. The default value is .sp .ne 2 -.mk .na \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1351,7 +1316,6 @@ default value is \fBon\fR. .sp .ne 2 -.mk .na \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1372,7 +1336,6 @@ 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 @@ -1394,7 +1357,6 @@ product. For more information about the \fBmixed\fR value behavior, see the .sp .ne 2 -.mk .na \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR @@ -1413,7 +1375,6 @@ cannot be changed after the file system is created. .sp .ne 2 -.mk .na \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1517,7 +1478,6 @@ All subcommands that modify state are logged persistently to the pool in their original form. .sp .ne 2 -.mk .na \fB\fBzfs ?\fR\fR .ad @@ -1528,7 +1488,6 @@ Displays a help message. .sp .ne 2 -.mk .na \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR\fR @@ -1539,7 +1498,6 @@ Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR property inherited from the parent. .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -1554,7 +1512,6 @@ operation completes successfully. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1571,7 +1528,6 @@ property is specified in multiple \fB-o\fR options. .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 @@ -1587,7 +1543,6 @@ exported by the device. By default, a reservation of equal size is created. the volume has an integral number of blocks regardless of \fIblocksize\fR. .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -1602,7 +1557,6 @@ operation completes successfully. .sp .ne 2 -.mk .na \fB\fB-s\fR\fR .ad @@ -1614,7 +1568,6 @@ Properties section for more information about sparse volumes. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1629,7 +1582,6 @@ multiple \fB-o\fR options. .sp .ne 2 -.mk .na \fB\fB-b\fR \fIblocksize\fR\fR .ad @@ -1644,7 +1596,6 @@ behavior is undefined. .sp .ne 2 -.mk .na \fB\fBzfs destroy\fR [\fB-rRf\fR] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -1656,7 +1607,6 @@ 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 @@ -1667,7 +1617,6 @@ Recursively destroy all children. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1679,7 +1628,6 @@ target hierarchy. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1689,14 +1637,13 @@ 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. .RE -Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR +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. .RE .sp .ne 2 -.mk .na \fB\fBzfs destroy\fR [\fB-rRd\fR] \fIsnapshot\fR\fR .ad @@ -1712,7 +1659,6 @@ deferred deletion. 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. .sp .ne 2 -.mk .na \fB\fB-d\fR\fR .ad @@ -1723,7 +1669,6 @@ Defer snapshot deletion. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -1735,7 +1680,6 @@ descendent file systems. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1748,7 +1692,6 @@ Recursively destroy all dependents. .sp .ne 2 -.mk .na \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR @@ -1760,7 +1703,6 @@ successful system calls to the file system are part of the snapshot. See the "Snapshots" section for details. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -1773,7 +1715,6 @@ time. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1786,7 +1727,6 @@ Sets the specified property; see \fBzfs create\fR for details. .sp .ne 2 -.mk .na \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR .ad @@ -1805,7 +1745,6 @@ 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 @@ -1816,7 +1755,6 @@ Recursively destroy any snapshots more recent than the one specified. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1828,7 +1766,6 @@ snapshots. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1842,7 +1779,6 @@ that are to be destroyed. .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 @@ -1854,7 +1790,6 @@ 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 @@ -1868,7 +1803,6 @@ operation completes successfully. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1881,7 +1815,6 @@ Sets the specified property; see \fBzfs create\fR for details. .sp .ne 2 -.mk .na \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR .ad @@ -1903,7 +1836,6 @@ any conflicting snapshots. .sp .ne 2 -.mk .na \fB\fBzfs rename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR .ad @@ -1926,7 +1858,6 @@ 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 @@ -1941,7 +1872,6 @@ from their parent. .sp .ne 2 -.mk .na \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR .ad @@ -1953,7 +1883,6 @@ only dataset that can be renamed recursively. .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 @@ -1970,7 +1899,6 @@ default is \fBoff\fR) . The following fields are displayed, \fBname,used,available,referenced,mountpoint\fR. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -1982,7 +1910,6 @@ tab instead of arbitrary white space. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -1993,7 +1920,6 @@ Recursively display any children of the dataset on the command line. .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdepth\fR\fR .ad @@ -2006,7 +1932,6 @@ children. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR\fR .ad @@ -2044,7 +1969,6 @@ filesystem,volume\fR syntax. .sp .ne 2 -.mk .na \fB\fB-s\fR \fIproperty\fR\fR .ad @@ -2088,7 +2012,6 @@ preserved. .sp .ne 2 -.mk .na \fB\fB-S\fR \fIproperty\fR\fR .ad @@ -2099,7 +2022,6 @@ Same as the \fB-s\fR option, but sorts by property in descending order. .sp .ne 2 -.mk .na \fB\fB-t\fR \fItype\fR\fR .ad @@ -2125,7 +2047,6 @@ Display numbers in parseable (exact) values. .sp .ne 2 -.mk .na \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR @@ -2144,7 +2065,6 @@ Properties" section. .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-s\fR \fIsource\fR[,...] "\fIall\fR" | @@ -2175,7 +2095,6 @@ The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot). .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -2186,7 +2105,6 @@ Recursively display properties for any children. .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdepth\fR\fR .ad @@ -2199,7 +2117,6 @@ children. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -2212,7 +2129,6 @@ arbitrary amount of space. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIfield\fR\fR .ad @@ -2224,7 +2140,6 @@ is the default value. .sp .ne 2 -.mk .na \fB\fB-s\fR \fIsource\fR\fR .ad @@ -2238,7 +2153,6 @@ is all sources. .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2251,7 +2165,6 @@ Display numbers in parseable (exact) values. .sp .ne 2 -.mk .na \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR @@ -2264,7 +2177,6 @@ no ancestor has the property set, then the default value is used. See the properties can be inherited. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -2277,7 +2189,6 @@ Recursively inherit the given property for all children. .sp .ne 2 -.mk .na \fB\fBzfs upgrade\fR [\fB-v\fR]\fR .ad @@ -2288,7 +2199,6 @@ Displays a list of file systems that are not the most recent version. .sp .ne 2 -.mk .na \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR @@ -2308,7 +2218,6 @@ 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 @@ -2319,7 +2228,6 @@ Upgrade all file systems on all imported pools. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2330,7 +2238,6 @@ Upgrade the specified file system. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -2341,7 +2248,6 @@ Upgrade the specified file system and all descendent file systems .sp .ne 2 -.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad @@ -2357,7 +2263,6 @@ supported by this software. .sp .ne 2 -.mk .na \fB\fBzfs userspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | @@ -2370,7 +2275,6 @@ filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and \fBuserquota@\fR\fIuser\fR properties. .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -2381,7 +2285,6 @@ Print numeric ID instead of user/group name. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -2392,7 +2295,6 @@ Do not print headers, use tab-delimited output. .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2403,7 +2305,6 @@ Use exact (parseable) numeric output. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIfield\fR[,...]\fR .ad @@ -2415,7 +2316,6 @@ Display only the specified fields from the following set, .sp .ne 2 -.mk .na \fB\fB-s\fR \fIfield\fR\fR .ad @@ -2428,7 +2328,6 @@ multiple times to sort first by one field, then by another. The default is .sp .ne 2 -.mk .na \fB\fB-S\fR \fIfield\fR\fR .ad @@ -2439,7 +2338,6 @@ Sort by this field in reverse order. See \fB-s\fR. .sp .ne 2 -.mk .na \fB\fB-t\fR \fItype\fR[,...]\fR .ad @@ -2455,7 +2353,6 @@ The default can be changed to include group types. .sp .ne 2 -.mk .na \fB\fB-i\fR\fR .ad @@ -2475,7 +2372,6 @@ will report that the POSIX entity has the total usage and quota for both. .sp .ne 2 -.mk .na \fB\fBzfs groupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | @@ -2498,7 +2394,6 @@ except that the default types to display are \fB-t posixgroup,smbgroup\fR. .sp .ne 2 -.mk .na \fB\fBzfs mount\fR\fR .ad @@ -2509,7 +2404,6 @@ Displays all \fBZFS\fR file systems currently mounted. .sp .ne 2 -.mk .na \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR | \fIfilesystem\fR\fR @@ -2520,7 +2414,6 @@ Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot process. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIoptions\fR\fR .ad @@ -2533,7 +2426,6 @@ details. .sp .ne 2 -.mk .na \fB\fB-O\fR\fR .ad @@ -2544,7 +2436,6 @@ Perform an overlay mount. See \fBmount\fR(1M) for more information. .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad @@ -2555,7 +2446,6 @@ Report mount progress. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2567,7 +2457,6 @@ the boot process. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2580,7 +2469,6 @@ Mount the specified filesystem. .sp .ne 2 -.mk .na \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2590,7 +2478,6 @@ 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 @@ -2601,7 +2488,6 @@ Forcefully unmount the file system, even if it is currently in use. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2613,7 +2499,6 @@ the boot process. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2627,7 +2512,6 @@ Unmount the specified filesystem. The command can also be given a path to a .sp .ne 2 -.mk .na \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR .ad @@ -2636,7 +2520,6 @@ Unmount the specified filesystem. The command can also be given a path to a Shares available \fBZFS\fR file systems. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2648,7 +2531,6 @@ the boot process. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2663,7 +2545,6 @@ Share the specified filesystem according to the \fBsharenfs\fR and .sp .ne 2 -.mk .na \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2673,7 +2554,6 @@ 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 @@ -2685,7 +2565,6 @@ the boot process. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2699,7 +2578,6 @@ Unshare the specified filesystem. The command can also be given a path to a .sp .ne 2 -.mk .na \fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR @@ -2712,7 +2590,6 @@ system (for example, using \fBssh\fR(1). By default, a full stream is generated. .sp .ne 2 -.mk .na \fB\fB-i\fR \fIsnapshot\fR\fR .ad @@ -2731,7 +2608,6 @@ must be fully specified (for example, \fBpool/fs@origin\fR, not just .sp .ne 2 -.mk .na \fB\fB-I\fR \fIsnapshot\fR\fR .ad @@ -2745,7 +2621,6 @@ be specified as with the \fB-i\fR option. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -2765,7 +2640,6 @@ snapshots and file systems that do not exist on the sending side are destroyed. .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad @@ -2780,7 +2654,6 @@ on future versions of \fBZFS\fR. .sp .ne 2 -.mk .na \fB\fBzfs receive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR @@ -2820,7 +2693,6 @@ determined by appending the sent snapshot's name to the specified systems within the specified one are created. .sp .ne 2 -.mk .na \fB\fB-d\fR\fR .ad @@ -2832,7 +2704,6 @@ described in the paragraph above. .sp .ne 2 -.mk .na \fB\fB-u\fR\fR .ad @@ -2843,7 +2714,6 @@ File system that is associated with the received stream is not mounted. .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad @@ -2855,7 +2725,6 @@ receive operation. .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -2867,7 +2736,6 @@ Do not actually receive the stream. This can be useful in conjunction with the .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -2883,7 +2751,6 @@ snapshots and file systems that do not exist on the sending side. .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR .ad @@ -2895,7 +2762,6 @@ volume. See the other forms of \fBzfs allow\fR for more information. .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 @@ -2911,7 +2777,6 @@ 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 @@ -2927,7 +2792,6 @@ group with the same name as a user, use the \fB-g\fR options. .sp .ne 2 -.mk .na \fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR .ad @@ -2942,7 +2806,6 @@ set names, which begin with an at sign (\fB@\fR) , may be specified. See the .sp .ne 2 -.mk .na \fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -2979,7 +2842,7 @@ receive subcommand Must also have the 'mount' and 'create' ability rename subcommand Must also have the 'mount' and 'create' ability in the new parent rollback subcommand Must also have the 'mount' ability -send subcommand +send subcommand share subcommand Allows sharing file systems over NFS or SMB protocols snapshot subcommand Must also have the 'mount' ability @@ -2989,46 +2852,45 @@ userprop other Allows changing any user property userquota other Allows accessing any userquota@... property userused other Allows reading any userused@... property -aclinherit property -aclmode property -atime property -canmount property -casesensitivity property -checksum property -compression property -copies property -devices property -exec property -mountpoint property -nbmand property -normalization property -primarycache property -quota property -readonly property -recordsize property -refquota property -refreservation property -reservation property -secondarycache property -setuid property -shareiscsi property -sharenfs property -sharesmb property -snapdir property -utf8only property -version property -volblocksize property -volsize property -vscan property -xattr property -zoned property +aclinherit property +aclmode property +atime property +canmount property +casesensitivity property +checksum property +compression property +copies property +devices property +exec property +mountpoint property +nbmand property +normalization property +primarycache property +quota property +readonly property +recordsize property +refquota property +refreservation property +reservation property +secondarycache property +setuid property +shareiscsi property +sharenfs property +sharesmb property +snapdir property +utf8only property +version property +volblocksize property +volsize property +vscan property +xattr property +zoned property .fi .in -2 .sp .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR @@ -3041,7 +2903,6 @@ creator of any newly-created descendent file system. .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR @@ -3058,7 +2919,6 @@ characters long. .sp .ne 2 -.mk .na \fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] @@ -3089,7 +2949,6 @@ 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 @@ -3102,7 +2961,6 @@ Recursively remove the permissions from this file system and all descendents. .sp .ne 2 -.mk .na \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR @@ -3119,7 +2977,6 @@ then all permissions are removed, thus removing the set entirely. .sp .ne 2 -.mk .na \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3133,7 +2990,6 @@ 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 @@ -3147,7 +3003,6 @@ snapshots of all descendent file systems. .sp .ne 2 -.mk .na \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR .ad @@ -3156,7 +3011,6 @@ snapshots of all descendent file systems. Lists all existing user references for the given snapshot or snapshots. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -3170,7 +3024,6 @@ listing the holds on the named snapshot. .sp .ne 2 -.mk .na \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3183,7 +3036,6 @@ 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 @@ -3528,7 +3380,7 @@ target. # \fBzfs set shareiscsi=on pool/volumes/vol1\fR # \fBiscsitadm list target\fR Target: pool/volumes/vol1 - iSCSI Name: + iSCSI Name: iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c Connections: 0 .fi @@ -3640,7 +3492,7 @@ Create time permissions on (tank/users) create,destroy Local+Descendent permissions on (tank/users) group staff create,mount -------------------------------------------------------------- +------------------------------------------------------------- .fi .in -2 .sp @@ -3691,7 +3543,7 @@ Local+Descendent permissions on (users/home) cindys% \fBzfs set quota=10G users/home/marks\fR cindys% \fBzfs get quota users/home/marks\fR NAME PROPERTY VALUE SOURCE -users/home/marks quota 10G local +users/home/marks quota 10G local .fi .in -2 .sp @@ -3716,7 +3568,7 @@ Create time permissions on (tank/users) create,destroy Local+Descendent permissions on (tank/users) group staff @pset,create,mount -------------------------------------------------------------- +------------------------------------------------------------- .fi .in -2 .sp @@ -3727,7 +3579,6 @@ Local+Descendent permissions on (tank/users) The following exit values are returned: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad @@ -3738,7 +3589,6 @@ Successful completion. .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad @@ -3749,7 +3599,6 @@ An error occurred. .sp .ne 2 -.mk .na \fB\fB2\fR\fR .ad @@ -3766,13 +3615,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO |