From 930b0d4c77b9dfdfbc48e7789233b758560e7d84 Mon Sep 17 00:00:00 2001 From: Richard Laager Date: Wed, 11 May 2016 14:16:21 -0500 Subject: [PATCH] Illumos 1502 Remove conversion cruft from manpages Reviewed by: Alexander Eremin Reviewed by: Gordon Ross Reviewed by: Garrett D'Amore References: https://www.illumos.org/issues/1502 Ported-by: Richard Laager Signed-off-by: Richard Laager Conflicts: man/man8/zpool.8 --- man/man8/zfs.8 | 188 ----------------------------------- man/man8/zpool.8 | 252 ----------------------------------------------- 2 files changed, 440 deletions(-) diff --git a/man/man8/zfs.8 b/man/man8/zfs.8 index da64a5d46..cce536ec7 100644 --- a/man/man8/zfs.8 +++ b/man/man8/zfs.8 @@ -278,7 +278,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\fIfilesystem\fR\fR .ad @@ -289,7 +288,6 @@ A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard .sp .ne 2 -.mk .na \fB\fIvolume\fR\fR .ad @@ -300,7 +298,6 @@ A logical volume exported as a raw or block device. This type of dataset should .sp .ne 2 -.mk .na \fB\fIsnapshot\fR\fR .ad @@ -311,7 +308,6 @@ A read-only version of a file system or volume at a given point in time. It is s .sp .ne 2 -.mk .na \fB\fIbookmark\fR\fR .ad @@ -412,7 +408,6 @@ The values of non-numeric native properties are case-sensitive and must be lower 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 @@ -425,7 +420,6 @@ This property can also be referred to by its shortened column name, \fBavail\fR. .sp .ne 2 -.mk .na \fB\fBcompressratio\fR\fR .ad @@ -436,7 +430,6 @@ For non-snapshots, the compression ratio achieved for the \fBused\fR space of th .sp .ne 2 -.mk .na \fB\fBcreation\fR\fR .ad @@ -447,7 +440,6 @@ The time this dataset was created. .sp .ne 2 -.mk .na \fB\fBclones\fR\fR .ad @@ -473,7 +465,6 @@ This property is \fBon\fR if the snapshot has been marked for deferred destructi .sp .ne 2 -.mk .na \fB\fBfilesystem_count\fR .ad @@ -530,7 +521,6 @@ For file systems, indicates whether the file system is currently mounted. This p .sp .ne 2 -.mk .na \fB\fBorigin\fR\fR .ad @@ -541,7 +531,6 @@ For cloned file systems or volumes, the snapshot from which the clone was create .sp .ne 2 -.mk .na \fB\fBreferenced\fR\fR .ad @@ -554,7 +543,6 @@ This property can also be referred to by its shortened column name, \fBrefer\fR. .sp .ne 2 -.mk .na \fB\fBrefcompressratio\fR\fR .ad @@ -567,7 +555,6 @@ property. .sp .ne 2 -.mk .na \fB\fBsnapshot_count\fR .ad @@ -590,7 +577,6 @@ The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR. .sp .ne 2 -.mk .na \fB\fBused\fR\fR .ad @@ -605,7 +591,6 @@ The amount of space used, available, or referenced does not take into account pe .sp .ne 2 -.mk .na \fB\fBusedby*\fR\fR .ad @@ -616,7 +601,6 @@ The \fBusedby*\fR properties decompose the \fBused\fR properties into the variou .sp .ne 2 -.mk .na \fB\fBusedbychildren\fR\fR .ad @@ -627,7 +611,6 @@ The amount of space used by children of this dataset, which would be freed if al .sp .ne 2 -.mk .na \fB\fBusedbydataset\fR\fR .ad @@ -638,7 +621,6 @@ The amount of space used by this dataset itself, which would be freed if the dat .sp .ne 2 -.mk .na \fB\fBusedbyrefreservation\fR\fR .ad @@ -649,7 +631,6 @@ The amount of space used by a \fBrefreservation\fR set on this dataset, which wo .sp .ne 2 -.mk .na \fB\fBusedbysnapshots\fR\fR .ad @@ -660,7 +641,6 @@ The amount of space consumed by snapshots of this dataset. In particular, it is .sp .ne 2 -.mk .na \fB\fBuserused@\fR\fIuser\fR\fR .ad @@ -700,7 +680,6 @@ Files created on Linux always have POSIX owners. .sp .ne 2 -.mk .na \fB\fBuserrefs\fR\fR .ad @@ -711,7 +690,6 @@ This property is set to the number of user holds on this snapshot. User holds ar .sp .ne 2 -.mk .na \fB\fBgroupused@\fR\fIgroup\fR\fR .ad @@ -724,7 +702,6 @@ Unprivileged users can only access their own groups' space usage. The root user, .sp .ne 2 -.mk .na \fB\fBvolblocksize\fR=\fIblocksize\fR\fR .ad @@ -772,7 +749,6 @@ of the origin's filesystem, etc). The following native properties can be used to change the behavior of a \fBZFS\fR dataset. .sp .ne 2 -.mk .na \fB\fBaclinherit\fR=\fBrestricted\fR | \fBdiscard\fR | \fBnoallow\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR .ad @@ -787,7 +763,6 @@ The \fBaclinherit\fR property does not apply to Posix ACLs. .sp .ne 2 -.mk .na \fB\fBacltype\fR=\fBoff\fR | \fBnoacl\fR | \fBposixacl\fR \fR .ad @@ -812,7 +787,6 @@ The value \fBnoacl\fR is an alias for \fBoff\fR. .sp .ne 2 -.mk .na \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -825,7 +799,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBatime\fR and \fBnoati .sp .ne 2 -.mk .na \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR .ad @@ -842,7 +815,6 @@ The values \fBon\fR and \fBnoauto\fR are equivalent to the \fBauto\fR and \fBnoa .sp .ne 2 -.mk .na \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR | \fBsha256\fR\fR .ad @@ -855,7 +827,6 @@ Changing this property affects only newly-written data. .sp .ne 2 -.mk .na \fB\fBcompression\fR=\fBoff\fR | \fBon\fR | \fBlzjb\fR | \fBlz4\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR\fR @@ -898,7 +869,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 @@ -913,7 +883,6 @@ Remember that \fBZFS\fR will not import a pool with a missing top-level vdev. Do .sp .ne 2 -.mk .na \fB\fBdedup\fR=\fBoff\fR | \fBon\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR .ad @@ -928,7 +897,6 @@ Unless necessary, deduplication should NOT be enabled on a system. See \fBDedupl .sp .ne 2 -.mk .na \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -941,7 +909,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBdev\fR and \fBnodev\f .sp .ne 2 -.mk .na \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -954,7 +921,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBexec\fR and \fBnoexec .sp .ne 2 -.mk .na \fB\fBmlslabel\fR=\fBnone\fR\fR | \fIlabel\fR .ad @@ -973,7 +939,6 @@ Zones are a Solaris feature and are not relevant on Linux. .sp .ne 2 -.mk .na \fB\fBfilesystem_limit\fR=\fBnone\fR\fR | \fIcount\fR .ad @@ -1001,7 +966,6 @@ When the \fBmountpoint\fR property is changed for a file system, the file system .sp .ne 2 -.mk .na \fB\fBnbmand\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1016,7 +980,6 @@ This property is not used on Linux. .sp .ne 2 -.mk .na \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -1027,7 +990,6 @@ Controls what is cached in the primary cache (ARC). If this property is set to \ .sp .ne 2 -.mk .na \fB\fBquota\fR=\fBnone\fR | \fIsize\fR\fR .ad @@ -1040,7 +1002,6 @@ Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an implic .sp .ne 2 -.mk .na \fB\fBsnapshot_limit\fR=\fBnone\fR\fR | \fIcount\fR .ad @@ -1098,7 +1059,6 @@ Files created on Linux always have POSIX owners. .sp .ne 2 -.mk .na \fB\fBgroupquota@\fR\fIgroup\fR=\fBnone\fR\fR | \fIsize\fR .ad @@ -1111,7 +1071,6 @@ Unprivileged users can access only their own groups' space usage. The root user, .sp .ne 2 -.mk .na \fB\fBreadonly\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1126,7 +1085,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBro\fR and \fBrw\fR mo .sp .ne 2 -.mk .na \fB\fBrecordsize\fR=\fIsize\fR\fR .ad @@ -1145,7 +1103,6 @@ This property can also be referred to by its shortened column name, \fBrecsize\f .sp .ne 2 -.mk .na \fB\fBredundant_metadata\fR=\fBall\fR | \fBmost\fR\fR .ad @@ -1187,7 +1144,6 @@ Limits the amount of space a dataset can consume. This property enforces a hard .sp .ne 2 -.mk .na \fB\fBrefreservation\fR=\fBnone\fR | \fIsize\fR\fR .ad @@ -1204,7 +1160,6 @@ This property can also be referred to by its shortened column name, \fBrefreserv .sp .ne 2 -.mk .na \fB\fBrelatime\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1217,7 +1172,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBrelatime\fR and \fBno .sp .ne 2 -.mk .na \fB\fBreservation\fR=\fBnone\fR | \fIsize\fR\fR .ad @@ -1230,7 +1184,6 @@ This property can also be referred to by its shortened column name, \fBreserv\fR .sp .ne 2 -.mk .na \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR .ad @@ -1241,7 +1194,6 @@ Controls what is cached in the secondary cache (L2ARC). If this property is set .sp .ne 2 -.mk .na \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -1254,7 +1206,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBsuid\fR and \fBnosuid .sp .ne 2 -.mk .na \fB\fBsharesmb\fR=\fBoff\fR | \fBon\fR .ad @@ -1270,7 +1221,6 @@ In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ( .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 @@ -1279,7 +1229,6 @@ smbmount //127.0.0.1/share_tmp /mnt/tmp -o user=workgroup/turbo,password=obrut,u .in -2 .sp .ne 2 -.mk .na \fBMinimal /etc/samba/smb.conf configuration\fR .sp @@ -1295,7 +1244,6 @@ smbmount //127.0.0.1/share_tmp /mnt/tmp -o user=workgroup/turbo,password=obrut,u .sp .ne 2 -.mk .na \fB\fBsharenfs\fR=\fBoff\fR | \fBon\fR | \fIopts\fR\fR .ad @@ -1316,7 +1264,6 @@ When the \fBsharenfs\fR property is changed for a dataset, the dataset and any c .sp .ne 2 -.mk .na \fB\fBlogbias\fR=\fBlatency\fR | \fBthroughput\fR\fR .ad @@ -1327,7 +1274,6 @@ Provide a hint to ZFS about handling of synchronous requests in this dataset. If .sp .ne 2 -.mk .na \fB\fBsnapdev\fR=\fBhidden\fR | \fBvisible\fR\fR .ad @@ -1340,7 +1286,6 @@ In this context, hidden does not refer to the concept of hiding files or directo .sp .ne 2 -.mk .na \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR .ad @@ -1351,7 +1296,6 @@ Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of .sp .ne 2 -.mk .na \fB\fBsync\fR=\fBstandard\fR | \fBalways\fR | \fBdisabled\fR\fR .ad @@ -1382,7 +1326,6 @@ The on-disk version of this file system, which is independent of the pool versio .sp .ne 2 -.mk .na \fB\fBvolsize\fR=\fIsize\fR\fR .ad @@ -1397,7 +1340,6 @@ A "sparse volume" (also known as "thin provisioning") can be created by specifyi .sp .ne 2 -.mk .na \fB\fBvscan\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1410,7 +1352,6 @@ This property is not used on Linux. .sp .ne 2 -.mk .na \fB\fBxattr\fR=\fBon\fR | \fBoff\fR | \fBsa\fR\fR .ad @@ -1445,7 +1386,6 @@ The values \fBon\fR and \fBoff\fR are equivalent to the \fBxattr\fR and \fBnoxat .sp .ne 2 -.mk .na \fB\fBzoned\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1459,7 +1399,6 @@ Controls whether the dataset is managed from a non-global zone. Zones are a Sola 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 @@ -1472,7 +1411,6 @@ The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the .sp .ne 2 -.mk .na \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR .ad @@ -1492,7 +1430,6 @@ This property cannot be changed after the file system is created. .sp .ne 2 -.mk .na \fB\fButf8only\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1514,7 +1451,6 @@ The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties ar .sp .ne 2 -.mk .na \fB\fBcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR .ad @@ -1525,7 +1461,6 @@ This flag sets the SELinux context for all files in the filesystem under the mou .sp .ne 2 -.mk .na \fB\fBfscontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR .ad @@ -1536,7 +1471,6 @@ This flag sets the SELinux context for the filesystem being mounted. See \fBsel .sp .ne 2 -.mk .na \fB\fBdefcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR .ad @@ -1547,7 +1481,6 @@ This flag sets the SELinux context for unlabeled files. See \fBselinux\fR(8) fo .sp .ne 2 -.mk .na \fB\fBrootcontext\fR=\fBnone\fR | \fISELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level\fR\fR .ad @@ -1558,7 +1491,6 @@ This flag sets the SELinux context for the root inode of the filesystem. See \f .sp .ne 2 -.mk .na \fB\fBoverlay\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -1613,7 +1545,6 @@ with the \fBzfs create\fR command set up and enable the swap area using the 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 @@ -1624,7 +1555,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 .ad @@ -1633,7 +1563,6 @@ Displays a help message. 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 @@ -1644,7 +1573,6 @@ Creates all the non-existing parent datasets. Datasets created in this manner in .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1657,7 +1585,6 @@ Sets the specified property as if the command \fBzfs set\fR \fIproperty\fR=\fIva .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 @@ -1668,7 +1595,6 @@ Creates a volume of the given size. The volume is exported as a block device in \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 @@ -1679,7 +1605,6 @@ Creates all the non-existing parent datasets as file systems. Datasets created i .sp .ne 2 -.mk .na \fB\fB-s\fR\fR .ad @@ -1690,7 +1615,6 @@ Creates a sparse volume by omitting the automatic creation of a \fBrefreservatio .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1703,7 +1627,6 @@ If \fB-o\fR \fBvolsize\fR is provided, the resulting behavior is undefined; it c .sp .ne 2 -.mk .na \fB\fB-b\fR \fIblocksize\fR\fR .ad @@ -1716,7 +1639,6 @@ Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is spe .sp .ne 2 -.mk .na \fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR .ad @@ -1725,7 +1647,6 @@ Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is spe 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 @@ -1736,7 +1657,6 @@ Recursively destroy all children. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1747,7 +1667,6 @@ Recursively destroy all dependents, including cloned file systems outside the ta .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1794,7 +1713,6 @@ Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR o .sp .ne 2 -.mk .na \fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...] .ad @@ -1815,7 +1733,6 @@ part after the \fB@\fR) should be specified when using a range or comma-separated list to identify multiple snapshots. .sp .ne 2 -.mk .na \fB\fB-d\fR\fR .ad @@ -1826,7 +1743,6 @@ If the snapshot does not qualify for immediate destruction, rather than returnin .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -1837,7 +1753,6 @@ Destroy (or mark for deferred destruction) all snapshots with this name in desce .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1890,7 +1805,6 @@ behavior for mounted file systems in use. .sp .ne 2 -.mk .na \fBzfs destroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR .ad @@ -1910,7 +1824,6 @@ The given bookmark is destroyed. 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 @@ -1921,7 +1834,6 @@ Recursively create snapshots of all descendent datasets. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -1934,7 +1846,6 @@ Sets the specified property; see \fBzfs set\fR for details. .sp .ne 2 -.mk .na \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR .ad @@ -1945,7 +1856,6 @@ Roll back the given dataset to a previous snapshot. When a dataset is rolled bac 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 @@ -1956,7 +1866,6 @@ Destroy any snapshots and bookmarks more recent than the one specified. .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -1967,7 +1876,6 @@ Recursively destroy any more recent snapshots and bookmarks, as well as any clon .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1980,7 +1888,6 @@ Used with the \fB-R\fR option to force an unmount (see \fBzfs unmount -f\fR) of .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 @@ -1989,7 +1896,6 @@ Used with the \fB-R\fR option to force an unmount (see \fBzfs unmount -f\fR) of 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 @@ -2000,7 +1906,6 @@ Creates all the non-existing parent datasets; see \fBzfs create\fR for details. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR .ad @@ -2013,7 +1918,6 @@ Sets the specified property; see \fBzfs set\fR for details. .sp .ne 2 -.mk .na \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR .ad @@ -2026,7 +1930,6 @@ The snapshot that was cloned, and any snapshots previous to this snapshot, are n .sp .ne 2 -.mk .na \fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR .ad @@ -2039,7 +1942,6 @@ The snapshot that was cloned, and any snapshots previous to this snapshot, are n 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 @@ -2062,7 +1964,6 @@ Force unmount any filesystems that need to be unmounted in the process. .sp .ne 2 -.mk .na \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR .ad @@ -2073,7 +1974,6 @@ Recursively rename the snapshots of all descendent datasets. Snapshots are the o .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 @@ -2082,7 +1982,6 @@ Recursively rename the snapshots of all descendent datasets. Snapshots are the o 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 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 @@ -2093,7 +1992,6 @@ Used for scripting mode. Do not print headers and separate fields by a single ta .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .sp .6 @@ -2103,7 +2001,6 @@ Display numbers in parsable (exact) values. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -2114,7 +2011,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 @@ -2125,7 +2021,6 @@ Recursively display any children of the dataset, limiting the recursion to \fIde .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty\fR\fR .ad @@ -2160,7 +2055,6 @@ The value \fBspace\fR to display space usage properties on file systems and volu .sp .ne 2 -.mk .na \fB\fB-s\fR \fIproperty\fR\fR .ad @@ -2197,7 +2091,6 @@ If no sorting options are specified the existing behavior of \fBzfs list\fR is p .sp .ne 2 -.mk .na \fB\fB-S\fR \fIproperty\fR\fR .ad @@ -2208,7 +2101,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 @@ -2221,7 +2113,6 @@ A comma-separated list of types to display, where \fItype\fR is one of \fBfilesy .sp .ne 2 -.mk .na \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR[ \fIproperty\fR=\fIvalue\fR]... \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR @@ -2236,7 +2127,6 @@ can be set on snapshots. For more information, see the "User 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-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR .ad .sp .6 @@ -2259,7 +2149,6 @@ All columns are displayed by default, though this can be controlled by using the 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 @@ -2270,7 +2159,6 @@ Recursively display properties for any children. .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdepth\fR\fR .ad @@ -2281,7 +2169,6 @@ Recursively display any children of the dataset, limiting the recursion to \fIde .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -2292,7 +2179,6 @@ Display output in a form more easily parsed by scripts. Any headers are omitted, .sp .ne 2 -.mk .na \fB\fB-o\fR \fIfield\fR\fR .ad @@ -2303,7 +2189,6 @@ A comma-separated list of columns to display. \fBname,property,value,source\fR i .sp .ne 2 -.mk .na \fB\fB-s\fR \fIsource\fR\fR .ad @@ -2314,7 +2199,6 @@ A comma-separated list of sources to display. Those properties coming from a sou .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2327,7 +2211,6 @@ Display numbers in parsable (exact) values. .sp .ne 2 -.mk .na \fB\fBzfs inherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR .ad @@ -2336,7 +2219,6 @@ Display numbers in parsable (exact) values. 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 @@ -2359,7 +2241,6 @@ if the \fB-S\fR option was not specified. .sp .ne 2 -.mk .na \fB\fBzfs upgrade\fR .ad @@ -2370,7 +2251,6 @@ Displays a list of file systems that are not the most recent version. .sp .ne 2 -.mk .na \fB\fBzfs upgrade\fR \fB-v\fR\fR .ad @@ -2382,7 +2262,6 @@ Displays a list of file system versions. .sp .ne 2 -.mk .na \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR .ad @@ -2395,7 +2274,6 @@ In general, the file system version is independent of the pool version. See \fBz 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 @@ -2406,7 +2284,6 @@ Upgrades all file systems on all imported pools. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2417,7 +2294,6 @@ Upgrades the specified file system. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -2428,7 +2304,6 @@ Upgrades the specified file system and all descendent file systems .sp .ne 2 -.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad @@ -2441,7 +2316,6 @@ Upgrades to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, .sp .ne 2 -.mk .na \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIfield\fR] ... @@ -2455,7 +2329,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 @@ -2466,7 +2339,6 @@ Print numeric ID instead of user/group name. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -2477,7 +2349,6 @@ Display output in a form more easily parsed by scripts. Any headers are omitted, .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2488,7 +2359,6 @@ Use exact (parsable) numeric output. .sp .ne 2 -.mk .na \fB\fB-o\fR \fIfield\fR[,...]\fR .ad @@ -2500,7 +2370,6 @@ set: \fBtype, name, used, quota\fR. The default is to display all fields. .sp .ne 2 -.mk .na \fB\fB-s\fR \fIfield\fR\fR .ad @@ -2513,7 +2382,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 @@ -2524,7 +2392,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 @@ -2538,7 +2405,6 @@ types. .sp .ne 2 -.mk .na \fB\fB-i\fR\fR .ad @@ -2560,7 +2426,6 @@ This option is not useful on Linux. .sp .ne 2 -.mk .na \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIfield\fR] ... @@ -2576,7 +2441,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 @@ -2587,7 +2451,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 .ad @@ -2596,7 +2459,6 @@ Displays all \fBZFS\fR file systems currently mounted. 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 @@ -2609,7 +2471,6 @@ details. .sp .ne 2 -.mk .na \fB\fB-O\fR\fR .ad @@ -2624,7 +2485,6 @@ On Linux, this is the default for \fBmount\fR(8). In other words, \fBzfs mount - .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad @@ -2635,7 +2495,6 @@ Report mount progress. This is intended for use with \fBzfs mount -a\fR on a sys .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2647,7 +2506,6 @@ the boot process. .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2660,7 +2518,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 @@ -2669,7 +2526,6 @@ Mount the specified filesystem. 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 @@ -2680,7 +2536,6 @@ Forcefully unmount the file system, even if it is currently in use. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2691,7 +2546,6 @@ Unmount all available \fBZFS\fR file systems. Invoked automatically as part of t .sp .ne 2 -.mk .na \fIfilesystem\fR|\fImountpoint\fR .ad @@ -2704,7 +2558,6 @@ Unmount the specified filesystem. The command can also be given a path to a \fBZ .sp .ne 2 -.mk .na \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR .ad @@ -2713,7 +2566,6 @@ Unmount the specified filesystem. The command can also be given a path to a \fBZ Shares available \fBZFS\fR file systems. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad @@ -2724,7 +2576,6 @@ Share all available \fBZFS\fR file systems. Invoked automatically as part of the .sp .ne 2 -.mk .na \fB\fIfilesystem\fR\fR .ad @@ -2737,7 +2588,6 @@ Share the specified filesystem according to the \fBsharenfs\fR and \fBsharesmb\f .sp .ne 2 -.mk .na \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2746,7 +2596,6 @@ Share the specified filesystem according to the \fBsharenfs\fR and \fBsharesmb\f 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 @@ -2757,7 +2606,6 @@ Unshare all available \fBZFS\fR file systems. Invoked automatically as part of t .sp .ne 2 -.mk .na \fB\fIfilesystem\fR|\fImountpoint\fR\fR .ad @@ -2770,7 +2618,6 @@ Unshare the specified filesystem. The command can also be given a path to a \fBZ .sp .ne 2 -.mk .na \fB\fBzfs bookmark\fR \fIsnapshot\fR \fIbookmark\fR\fR .ad @@ -2797,7 +2644,6 @@ See \fBzpool-features\fR(5) for details on ZFS feature flags and the 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 @@ -2810,7 +2656,6 @@ If the destination is a clone, the source may be the origin snapshot, which must .sp .ne 2 -.mk .na \fB\fB-I\fR \fIsnapshot\fR\fR .ad @@ -2821,7 +2666,6 @@ Generate a stream package that sends all intermediary snapshots from the first s .sp .ne 2 -.mk .na \fB\fB-R\fR\fR .ad @@ -2834,7 +2678,6 @@ If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad @@ -2845,7 +2688,6 @@ Generate a deduplicated stream. Blocks which would have been sent multiple times .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad @@ -2861,7 +2703,6 @@ flags and the \fBlarge_blocks\fR feature. .sp .ne 2 -.mk .na \fB\fB-e\fR\fR .ad @@ -2913,7 +2754,6 @@ Print machine-parsable verbose information about the stream package generated. .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad @@ -2960,7 +2800,6 @@ or the origin's origin, etc. .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad @@ -2976,7 +2815,6 @@ flags and the \fBlarge_blocks\fR feature. .sp .ne 2 -.mk .na \fB\fB-e\fR\fR .ad @@ -2995,7 +2833,6 @@ then the receiving system must have that feature enabled as well. See .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 @@ -3018,7 +2855,6 @@ If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If 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 @@ -3039,7 +2875,6 @@ Discard all but the last element of the sent snapshot's file system name, using .sp .ne 2 -.mk .na \fB\fB-u\fR\fR .ad @@ -3060,7 +2895,6 @@ Print verbose information about the stream and the time required to perform the .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -3071,7 +2905,6 @@ Do not actually receive the stream. This can be useful in conjunction with the \ .sp .ne 2 -.mk .na \fB\fB-o\fR \fBorigin\fR=\fIsnapshot\fR .ad @@ -3082,7 +2915,6 @@ Forces the stream to be received as a clone of the given snapshot. This is only .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -3095,7 +2927,6 @@ Force a rollback of the file system to the most recent snapshot before performin .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR .ad @@ -3106,7 +2937,6 @@ Displays permissions that have been delegated on the specified filesystem or vol .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 @@ -3119,7 +2949,6 @@ Displays permissions that have been delegated on the specified filesystem or vol 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 @@ -3130,7 +2959,6 @@ Specifies to whom the permissions are delegated. Multiple entities can be specif .sp .ne 2 -.mk .na \fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR .ad @@ -3141,7 +2969,6 @@ Specifies that the permissions be delegated to "everyone." Multiple permissions .sp .ne 2 -.mk .na \fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -3228,7 +3055,6 @@ zoned property .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -3239,7 +3065,6 @@ Sets "create time" permissions. These permissions are granted (locally) to the c .sp .ne 2 -.mk .na \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -3250,7 +3075,6 @@ Defines or adds permissions to a permission set. The set can be used by other \f .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 @@ -3267,7 +3091,6 @@ Defines or adds permissions to a permission set. The set can be used by other \f 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 @@ -3280,7 +3103,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 \fB\fIfilesystem\fR|\fIvolume\fR\fR .ad @@ -3291,7 +3113,6 @@ Removes permissions from a permission set. If no permissions are specified, then .sp .ne 2 -.mk .na \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3302,7 +3123,6 @@ Adds a single reference, named with the \fItag\fR argument, to the specified sna 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 @@ -3315,7 +3135,6 @@ Specifies that a hold with the given tag is applied recursively to the snapshots .sp .ne 2 -.mk .na \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR .ad @@ -3324,7 +3143,6 @@ Specifies that a hold with the given tag is applied recursively to the snapshots Lists all existing user references for the given snapshot or snapshots. .sp .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -3337,7 +3155,6 @@ Lists the holds that are set on the named descendent snapshots, in addition to l .sp .ne 2 -.mk .na \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR .ad @@ -3346,7 +3163,6 @@ Lists the holds that are set on the named descendent snapshots, in addition to l 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 .ne 2 -.mk .na \fB\fB-r\fR\fR .ad @@ -3359,7 +3175,6 @@ Recursively releases a hold with the given tag on the snapshots of all descenden .sp .ne 2 -.mk .na \fB\fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR .ad @@ -3937,7 +3752,6 @@ Cause \fBzfs\fR to dump core on exit for the purposes of running \fB::findleaks\ The following exit values are returned: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad @@ -3948,7 +3762,6 @@ Successful completion. .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad @@ -3959,7 +3772,6 @@ An error occurred. .sp .ne 2 -.mk .na \fB\fB2\fR\fR .ad diff --git a/man/man8/zpool.8 b/man/man8/zpool.8 index cb9b48e1b..8927407c6 100644 --- a/man/man8/zpool.8 +++ b/man/man8/zpool.8 @@ -189,40 +189,33 @@ All datasets within a storage pool share the same space. See \fBzfs\fR(8) for in A "virtual device" describes a single device or a collection of devices organized according to certain performance and fault characteristics. The following virtual devices are supported: .sp .ne 2 -.mk .na \fB\fBdisk\fR\fR .ad .RS 10n -.rt A block device, typically located under \fB/dev\fR. \fBZFS\fR can use individual partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion of the path under "/dev"). For example, "sda" is equivalent to "/dev/sda". A whole disk can be specified by omitting the partition designation. When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary. .RE .sp .ne 2 -.mk .na \fB\fBfile\fR\fR .ad .RS 10n -.rt A regular file. The use of files as a backing store is strongly discouraged. It is designed primarily for experimental purposes, as the fault tolerance of a file is only as good as the file system of which it is a part. A file must be specified by a full path. .RE .sp .ne 2 -.mk .na \fB\fBmirror\fR\fR .ad .RS 10n -.rt A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR) devices failing before data integrity is compromised. .RE .sp .ne 2 -.mk .na \fB\fBraidz\fR\fR .ad @@ -239,7 +232,6 @@ A mirror of two or more devices. Data is replicated in an identical fashion acro \fB\fBraidz3\fR\fR .ad .RS 10n -.rt A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks within a \fBraidz\fR group. .sp A \fBraidz\fR group can have single-, double- , or triple parity, meaning that the \fBraidz\fR group can sustain one, two, or three failures, respectively, without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a single-parity \fBraidz\fR group; the \fBraidz2\fR \fBvdev\fR type specifies a double-parity \fBraidz\fR group; and the \fBraidz3\fR \fBvdev\fR type specifies a triple-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias for \fBraidz1\fR. @@ -249,34 +241,28 @@ A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity disks .sp .ne 2 -.mk .na \fB\fBspare\fR\fR .ad .RS 10n -.rt A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section. .RE .sp .ne 2 -.mk .na \fB\fBlog\fR\fR .ad .RS 10n -.rt A separate-intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR \fBvdev\fR types are not supported for the intent log. For more information, see the "Intent Log" section. .RE .sp .ne 2 -.mk .na \fB\fBcache\fR\fR .ad .RS 10n -.rt A device used to cache storage pool data. A cache device cannot be configured as a mirror or \fBraidz\fR group. For more information, see the "Cache Devices" section. .RE @@ -312,12 +298,10 @@ A pool's health status is described by one of three states: online, degraded, or The health of the top-level vdev, such as mirror or \fBraidz\fR device, is potentially impacted by the state of its associated vdevs, or component devices. A top-level vdev or component device is in one of the following states: .sp .ne 2 -.mk .na \fB\fBDEGRADED\fR\fR .ad .RS 12n -.rt One or more top-level vdevs is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning. .sp One or more component devices is in the degraded or faulted state, but sufficient replicas exist to continue functioning. The underlying conditions are as follows: @@ -337,12 +321,10 @@ The number of I/O errors exceeds acceptable levels. The device could not be mark .sp .ne 2 -.mk .na \fB\fBFAULTED\fR\fR .ad .RS 12n -.rt One or more top-level vdevs is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning. .sp One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows: @@ -362,45 +344,37 @@ The number of I/O errors exceeds acceptable levels and the device is faulted to .sp .ne 2 -.mk .na \fB\fBOFFLINE\fR\fR .ad .RS 12n -.rt The device was explicitly taken offline by the "\fBzpool offline\fR" command. .RE .sp .ne 2 -.mk .na \fB\fBONLINE\fR\fR .ad .RS 12n -.rt The device is online and functioning. .RE .sp .ne 2 -.mk .na \fB\fBREMOVED\fR\fR .ad .RS 12n -.rt The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms. .RE .sp .ne 2 -.mk .na \fB\fBUNAVAIL\fR\fR .ad .RS 12n -.rt The device could not be opened. If a pool is imported when a device was unavailable, then the device will be identified by a unique identifier instead of its path since the path was never correct in the first place. .RE @@ -476,34 +450,28 @@ The content of the cache devices is considered volatile, as is the case with oth Each pool has several properties associated with it. Some properties are read-only statistics while others are configurable and change the behavior of the pool. The following are read-only properties: .sp .ne 2 -.mk .na \fB\fBavailable\fR\fR .ad .RS 20n -.rt Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail". .RE .sp .ne 2 -.mk .na \fB\fBcapacity\fR\fR .ad .RS 20n -.rt Percentage of pool space used. This property can also be referred to by its shortened column name, "cap". .RE .sp .ne 2 -.mk .na \fB\fBexpandsize\fR\fR .ad .RS 20n -.rt Amount of uninitialized space within the pool or device that can be used to increase the total capacity of the pool. Uninitialized space consists of any space on an EFI labeled vdev which has not been brought online @@ -512,34 +480,28 @@ any space on an EFI labeled vdev which has not been brought online .sp .ne 2 -.mk .na \fB\fBfragmentation\fR\fR .ad .RS 20n -.rt The amount of fragmentation in the pool. .RE .sp .ne 2 -.mk .na \fB\fBfree\fR\fR .ad .RS 20n -.rt The amount of free space available in the pool. .RE .sp .ne 2 -.mk .na \fB\fBfreeing\fR\fR .ad .RS 20n -.rt After a file system or snapshot is destroyed, the space it was using is returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease @@ -548,45 +510,37 @@ while \fB\fBfree\fR\fR increases. .sp .ne 2 -.mk .na \fB\fBhealth\fR\fR .ad .RS 20n -.rt The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR". .RE .sp .ne 2 -.mk .na \fB\fBguid\fR\fR .ad .RS 20n -.rt A unique identifier for the pool. .RE .sp .ne 2 -.mk .na \fB\fBsize\fR\fR .ad .RS 20n -.rt Total size of the storage pool. .RE .sp .ne 2 -.mk .na \fB\fBunsupported@\fR\fIfeature_guid\fR\fR .ad .RS 20n -.rt .sp Information about unsupported features that are enabled on the pool. See \fBzpool-features\fR(5) for details. @@ -594,12 +548,10 @@ Information about unsupported features that are enabled on the pool. See .sp .ne 2 -.mk .na \fB\fBused\fR\fR .ad .RS 20n -.rt Amount of storage space used within the pool. .RE @@ -612,7 +564,6 @@ The space usage properties report actual physical space available to the storage The following property can be set at creation time: .sp .ne 2 -.mk .na \fB\fBashift\fR=\fIashift\fR\fR .ad @@ -630,7 +581,6 @@ Keep in mind is that the \fBashift\fR is \fIvdev\fR specific and is not a \fIpoo The following property can be set at creation time and import time: .sp .ne 2 -.mk .na \fB\fBaltroot\fR=(unset) | \fIpath\fR\fR .ad @@ -644,7 +594,6 @@ Alternate root directory. If set, this directory is prepended to any mount point The following property can only be set at import time: .sp .ne 2 -.mk .na \fB\fBreadonly\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -662,7 +611,6 @@ To write to a read-only pool, a export and import of the pool is required. The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command: .sp .ne 2 -.mk .na \fB\fBautoexpand\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -673,7 +621,6 @@ Controls automatic pool expansion when the underlying LUN is grown. If set to \f .sp .ne 2 -.mk .na \fB\fBautoreplace\fR=\fBoff\fR | \fBon\fR\fR .ad @@ -684,7 +631,6 @@ Controls automatic device replacement. If set to "\fBoff\fR", device replacement .sp .ne 2 -.mk .na \fB\fBbootfs\fR=(unset) | \fIpool\fR/\fIdataset\fR\fR .ad @@ -695,7 +641,6 @@ Identifies the default bootable dataset for the root pool. This property is expe .sp .ne 2 -.mk .na \fB\fBcachefile\fR=fBnone\fR | \fIpath\fR\fR .ad @@ -708,7 +653,6 @@ Multiple pools can share the same cache file. Because the kernel destroys and re .sp .ne 2 -.mk .na \fB\fBcomment\fR=(unset) | \fB\fItext\fR\fR .ad @@ -719,7 +663,6 @@ A text string consisting of printable ASCII characters that will be stored such .sp .ne 2 -.mk .na \fB\fBdedupditto\fR=\fB\fInumber\fR\fR .ad @@ -730,7 +673,6 @@ Threshold for the number of block ditto copies. If the reference count for a ded .sp .ne 2 -.mk .na \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -741,7 +683,6 @@ Controls whether a non-privileged user is granted access based on the dataset pe .sp .ne 2 -.mk .na \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR .ad @@ -750,34 +691,28 @@ Controls whether a non-privileged user is granted access based on the dataset pe Controls the system behavior in the event of catastrophic pool failure. This condition is typically a result of a loss of connectivity to the underlying storage device(s) or a failure of all devices within the pool. The behavior of such an event is determined as follows: .sp .ne 2 -.mk .na \fB\fBwait\fR\fR .ad .RS 12n -.rt Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior. .RE .sp .ne 2 -.mk .na \fB\fBcontinue\fR\fR .ad .RS 12n -.rt Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any of the remaining healthy devices. Any write requests that have yet to be committed to disk would be blocked. .RE .sp .ne 2 -.mk .na \fB\fBpanic\fR\fR .ad .RS 12n -.rt Prints out a message to the console and generates a system crash dump. .RE @@ -797,7 +732,6 @@ details on feature states. .sp .ne 2 -.mk .na \fB\fBlistsnapshots\fR=on | off\fR .ad @@ -810,7 +744,6 @@ This property can also be referred to by its shortened name, \fBlistsnaps\fR. .sp .ne 2 -.mk .na \fB\fBversion\fR=(unset) | \fIversion\fR\fR .ad @@ -828,7 +761,6 @@ All subcommands that modify state are logged persistently to the pool in their o The \fBzpool\fR command provides subcommands to create and destroy storage pools, add capacity to storage pools, and provide information about the storage pools. The following subcommands are supported: .sp .ne 2 -.mk .na \fB\fBzpool\fR \fB-?\fR\fR .ad @@ -839,7 +771,6 @@ Displays a help message. .sp .ne 2 -.mk .na \fB\fBzpool add\fR [\fB-fgLnP\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -848,62 +779,51 @@ Displays a help message. Adds the specified virtual devices to the given pool. The \fIvdev\fR specification is described in the "Virtual Devices" section. The behavior of the \fB-f\fR option, and the device checks performed are described in the "zpool create" subcommand. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner. .RE .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 6n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 6n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad .RS 6n -.rt Displays the configuration that would be used without actually adding the \fBvdev\fRs. The actual pool creation can still fail due to insufficient privileges or device sharing. .RE .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 6n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -917,7 +837,6 @@ Do not add a disk that is currently configured as a quorum device to a zpool. Af .sp .ne 2 -.mk .na \fB\fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR .ad @@ -926,18 +845,15 @@ Do not add a disk that is currently configured as a quorum device to a zpool. Af Attaches \fInew_device\fR to an existing \fBzpool\fR device. The existing device cannot be part of a \fBraidz\fR configuration. If \fIdevice\fR is not currently part of a mirrored configuration, \fIdevice\fR automatically transforms into a two-way mirror of \fIdevice\fR and \fInew_device\fR. If \fIdevice\fR is part of a two-way mirror, attaching \fInew_device\fR creates a three-way mirror, and so on. In either case, \fInew_device\fR begins to resilver immediately. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -950,7 +866,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR .ad @@ -961,7 +876,6 @@ Clears device errors in a pool. If no arguments are specified, all device errors .sp .ne 2 -.mk .na \fB\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] [\fB-t\fR \fItname\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -978,7 +892,6 @@ Unless the \fB-R\fR option is specified, the default mount point is "/\fIpool\fR By default all supported features are enabled on the new pool unless the \fB-d\fR option is specified. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -989,7 +902,6 @@ Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting r .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -1000,7 +912,6 @@ Displays the configuration that would be used without actually creating the pool .sp .ne 2 -.mk .na \fB\fB-d\fR\fR .ad @@ -1021,7 +932,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fB-O\fR \fIfile-system-property=value\fR\fR .ad @@ -1036,7 +946,6 @@ Sets the given file system properties in the root file system of the pool. See t .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1047,7 +956,6 @@ Equivalent to "-o cachefile=none,altroot=\fIroot\fR" .sp .ne 2 -.mk .na \fB\fB-m\fR \fImountpoint\fR\fR .ad @@ -1058,7 +966,6 @@ Sets the mount point for the root dataset. The default mount point is "/\fIpool\ .sp .ne 2 -.mk .na \fB\fB-t\fR \fItname\fR\fR .ad @@ -1071,7 +978,6 @@ Sets the in-core pool name to "\fBtname\fR" while the on-disk name will be the n .sp .ne 2 -.mk .na \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR .ad @@ -1080,12 +986,10 @@ Sets the in-core pool name to "\fBtname\fR" while the on-disk name will be the n Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces any active datasets contained within the pool to be unmounted. .RE @@ -1093,7 +997,6 @@ Forces any active datasets contained within the pool to be unmounted. .sp .ne 2 -.mk .na \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR .ad @@ -1106,7 +1009,6 @@ Detaches \fIdevice\fR from a mirror. The operation is refused if there are no ot .sp .ne 2 -.mk .na \fBzpool events\fR [\fB-vHfc\fR] [\fIpool\fR] ... .ad @@ -1116,45 +1018,37 @@ Description of the different events generated by the ZFS kernel modules. See \fB .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 6n -.rt Get a full detail of the events and what information is available about it. .RE .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 6n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Follow mode. .RE .sp .ne 2 -.mk .na \fB\fB-c\fR\fR .ad .RS 6n -.rt Clear all previous events. .RE @@ -1162,7 +1056,6 @@ Clear all previous events. .sp .ne 2 -.mk .na \fB\fBzpool export\fR [\fB-a\fR] [\fB-f\fR] \fIpool\fR ...\fR .ad @@ -1175,23 +1068,19 @@ Before exporting the pool, all datasets within the pool are unmounted. A pool ca For pools to be portable, you must give the \fBzpool\fR command whole disks, not just partitions, so that \fBZFS\fR can label the disks with portable \fBEFI\fR labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 6n -.rt Exports all pools imported on the system. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forcefully unmount all datasets, using the "\fBunmount -f\fR" command. .sp This command will forcefully export the pool even if it has a shared spare that is currently being used. This may lead to potential data corruption. @@ -1201,7 +1090,6 @@ This command will forcefully export the pool even if it has a shared spare that .sp .ne 2 -.mk .na \fB\fBzpool get\fR [\fB-Hp\fR] [\fB-o \fR\fIfield\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR @@ -1224,23 +1112,19 @@ See the "Properties" section for more information on the available pool properti .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 6n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad .RS 6n -.rt Display numbers in parseable (exact) values. .RE @@ -1259,7 +1143,6 @@ is the default value. .sp .ne 2 -.mk .na \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR .ad @@ -1268,23 +1151,19 @@ is the default value. Displays the command history of the specified pools or all pools if no pool is specified. .sp .ne 2 -.mk .na \fB\fB-i\fR\fR .ad .RS 6n -.rt Displays internally logged \fBZFS\fR events in addition to user initiated events. .RE .sp .ne 2 -.mk .na \fB\fB-l\fR\fR .ad .RS 6n -.rt Displays log records in long format, which in addition to standard format includes, the user name, the hostname, and the zone in which the operation was performed. .RE @@ -1292,7 +1171,6 @@ Displays log records in long format, which in addition to standard format includ .sp .ne 2 -.mk .na \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR .ad @@ -1303,34 +1181,28 @@ Lists pools available to import. If the \fB-d\fR option is not specified, this c The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available. .sp .ne 2 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 16n -.rt Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices. .RE .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 16n -.rt Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. .RE .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad .RS 16n -.rt Lists destroyed pools only. .RE @@ -1338,7 +1210,6 @@ Lists destroyed pools only. .sp .ne 2 -.mk .na \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] [\fB-s\fR] \fB-a\fR\fR .ad @@ -1347,73 +1218,60 @@ Lists destroyed pools only. Imports all pools found in the search directories. Identical to the previous command, except that all pools with a sufficient number of devices available are imported. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR" command, will not be imported unless the \fB-D\fR option is specified. .sp .ne 2 -.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad .RS 21n -.rt Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(8) for a description of dataset properties and mount options. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad .RS 21n -.rt Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties. .RE .sp .ne 2 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 21n -.rt Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices. .RE .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 21n -.rt Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. This option is incompatible with the \fB-c\fR option. .RE .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad .RS 21n -.rt Imports destroyed pools only. The \fB-f\fR option is also required. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 21n -.rt Forces import, even if the pool appears to be potentially active. .RE .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -1423,18 +1281,15 @@ Recovery mode for a non-importable pool. Attempt to return the pool to an import .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 21n -.rt Searches for and imports all pools found. .RE .sp .ne 2 -.mk .na \fB\fB-m\fR\fR .ad @@ -1444,18 +1299,15 @@ Allows a pool to import when there is a missing log device. .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad .RS 21n -.rt Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR". .RE .sp .ne 2 -.mk .na \fB\fB-N\fR\fR .ad @@ -1465,7 +1317,6 @@ Import the pool without mounting any file systems. .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -1475,7 +1326,6 @@ Used with the \fB-F\fR recovery option. Determines whether a non-importable pool .sp .ne 2 -.mk .na \fB\fB-X\fR\fR .ad @@ -1486,7 +1336,6 @@ Used with the \fB-F\fR recovery option. Determines whether extreme measures to f .sp .ne 2 -.mk .na \fB\fB-T\fR\fR .ad @@ -1497,12 +1346,10 @@ Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about .sp .ne 2 -.mk .na \fB\fB-s\fR .ad .RS 21n -.rt Scan using the default search path, the libblkid cache will not be consulted. A custom search path may be specified by setting the \fBZPOOL_IMPORT_PATH\fR environment variable. .RE @@ -1510,7 +1357,6 @@ Scan using the default search path, the libblkid cache will not be consulted. A .sp .ne 2 -.mk .na \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] [\fB-t\fR]] [\fB-s\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR .ad @@ -1521,7 +1367,6 @@ Imports a specific pool. A pool can be identified by its name or the numeric ide If a device is removed from a system without running "\fBzpool export\fR" first, the device appears as potentially active. It cannot be determined if this was a failed export, or whether the device is really in use from another host. To import a pool in this state, the \fB-f\fR option is required. .sp .ne 2 -.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad @@ -1532,7 +1377,6 @@ Comma-separated list of mount options to use when mounting datasets within the p .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad @@ -1543,7 +1387,6 @@ Sets the specified property on the imported pool. See the "Properties" section f .sp .ne 2 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad @@ -1554,7 +1397,6 @@ Reads configuration from the given \fBcachefile\fR that was created with the "\f .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad @@ -1565,7 +1407,6 @@ Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad @@ -1576,7 +1417,6 @@ Imports destroyed pool. The \fB-f\fR option is also required. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1587,7 +1427,6 @@ Forces import, even if the pool appears to be potentially active. .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -1598,7 +1437,6 @@ Recovery mode for a non-importable pool. Attempt to return the pool to an import .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1609,7 +1447,6 @@ Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" prop .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -1620,7 +1457,6 @@ Used with the \fB-F\fR recovery option. Determines whether a non-importable pool .sp .ne 2 -.mk .na \fB\fB-X\fR\fR .ad @@ -1632,7 +1468,6 @@ Used with the \fB-F\fR recovery option. Determines whether extreme measures to f .sp .ne 2 -.mk .na \fB\fB-T\fR\fR .ad @@ -1644,7 +1479,6 @@ Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about .sp .ne 2 -.mk .na \fB\fB-t\fR\fR .ad @@ -1655,7 +1489,6 @@ Used with "\fBnewpool\fR". Specifies that "\fBnewpool\fR" is temporary. Temporar .sp .ne 2 -.mk .na \fB\fB-m\fR\fR .ad @@ -1666,7 +1499,6 @@ Allows a pool to import when there is a missing log device. .sp .ne 2 -.mk .na \fB\fB-s\fR .ad @@ -1679,7 +1511,6 @@ Scan using the default search path, the libblkid cache will not be consulted. A .sp .ne 2 -.mk .na \fB\fBzpool iostat\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-ghHLpPvy\fR] [\fB-w\fR|[\fB-lq\fR]] [[\fIpool\fR ...]|[\fIpool vdev\fR ...]|[\fIvdev\fR ...]] [\fIinterval\fR[\fIcount\fR]]\fR @@ -1699,12 +1530,10 @@ note that the units of 'K', 'M', 'G'... that are printed in the report are in base 1024. To get the raw values, use the \fB-p\fR flag. .sp .ne 2 -.mk .na \fB\fB-T\fR \fBu\fR | \fBd\fR\fR .ad .RS 12n -.rt Display a time stamp. .sp Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See \fBdate\fR(1). @@ -1712,18 +1541,15 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -1739,13 +1565,11 @@ Scripted mode. Do not display headers, and separate fields by a single tab inste \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -1761,29 +1585,24 @@ Display numbers in parseable (exact) values. Time values are in nanoseconds. \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics. .RE .sp .ne 2 -.mk .na \fB\fB-y\fR\fR .ad .RS 12n -.rt Omit statistics since boot. Normally the first line of output reports the statistics since boot. This option suppresses that first line of output. .RE .sp @@ -1959,7 +1778,6 @@ from the end of the interval. .RE .sp .ne 2 -.mk .na \fB\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR .ad @@ -1968,12 +1786,10 @@ from the end of the interval. Removes ZFS label information from the specified device. The device must not be part of an active pool configuration. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 12n -.rt Treat exported or foreign devices as inactive. .RE @@ -1981,7 +1797,6 @@ Treat exported or foreign devices as inactive. .sp .ne 2 -.mk .na \fB\fBzpool list\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-HgLpPv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR .ad @@ -1990,40 +1805,33 @@ Treat exported or foreign devices as inactive. Lists the given pools along with a health status and space usage. If no \fIpools\fR are specified, all pools in the system are listed. When given an \fIinterval\fR, the information is printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 12n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2039,18 +1847,15 @@ Display numbers in parsable (exact) values. \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-T\fR \fBd\fR | \fBu\fR\fR .ad .RS 12n -.rt Display a time stamp. .sp Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See \fBdate\fR(1). @@ -2058,23 +1863,19 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fB-o\fR \fIprops\fR\fR .ad .RS 12n -.rt Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is "name, size, used, available, fragmentation, expandsize, capacity, dedupratio, health, altroot" .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wise statistics. .RE @@ -2082,7 +1883,6 @@ Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within t .sp .ne 2 -.mk .na \fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR .ad @@ -2093,12 +1893,10 @@ Takes the specified physical device offline. While the \fIdevice\fR is offline, This command is not applicable to spares or cache devices. .sp .ne 2 -.mk .na \fB\fB-t\fR\fR .ad .RS 6n -.rt Temporary. Upon reboot, the specified physical device reverts to its previous state. .RE @@ -2106,7 +1904,6 @@ Temporary. Upon reboot, the specified physical device reverts to its previous st .sp .ne 2 -.mk .na \fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR .ad @@ -2117,12 +1914,10 @@ Brings the specified physical device online. This command is not applicable to spares or cache devices. .sp .ne 2 -.mk .na \fB\fB-e\fR\fR .ad .RS 6n -.rt Expand the device to use all available space. If the device is part of a mirror or \fBraidz\fR then all devices must be expanded before the new space will become available to the pool. .RE @@ -2130,7 +1925,6 @@ Expand the device to use all available space. If the device is part of a mirror .sp .ne 2 -.mk .na \fB\fBzpool reguid\fR \fIpool\fR .ad @@ -2162,7 +1956,6 @@ Removes the specified device from the pool. This command currently only supports .sp .ne 2 -.mk .na \fB\fBzpool replace\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR .ad @@ -2175,18 +1968,15 @@ The size of \fInew_device\fR must be greater than or equal to the minimum size o \fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR is not specified, it defaults to \fIold_device\fR. This form of replacement is useful after an existing disk has failed and has been physically replaced. In this case, the new disk may have the same \fB/dev\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -2199,7 +1989,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR .ad @@ -2212,12 +2001,10 @@ Scrubbing and resilvering are very similar operations. The difference is that re Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR only allows one at a time. If a scrub is already in progress, the "\fBzpool scrub\fR" command terminates it and starts a new scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes. .sp .ne 2 -.mk .na \fB\fB-s\fR\fR .ad .RS 6n -.rt Stop scrubbing. .RE @@ -2225,7 +2012,6 @@ Stop scrubbing. .sp .ne 2 -.mk .na \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR .ad @@ -2236,7 +2022,6 @@ Sets the given property on the specified pool. See the "Properties" section for .sp .ne 2 -.mk .na \fBzpool split\fR [\fB-gLnP\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ...] .ad @@ -2248,29 +2033,24 @@ The optional \fIdevice\fR specification causes the specified device(s) to be inc .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 6n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 6n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-n\fR \fR .ad @@ -2281,18 +2061,15 @@ Do dry run, do not actually perform the split. Print out the expected configurat .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 6n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-R\fR \fIaltroot\fR \fR .ad @@ -2303,7 +2080,6 @@ Set \fIaltroot\fR for \fInewpool\fR and automatically import it. This can be us .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR \fR .ad @@ -2316,7 +2092,6 @@ Sets the specified property for \fInewpool\fR. See the “Properties” section .sp .ne 2 -.mk .na \fBzpool status\fR [\fB-gLPvxD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]] .ad @@ -2328,79 +2103,65 @@ If a scrub or resilver is in progress, this command reports the percentage done .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used innplace of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. .RE .sp .ne 2 -.mk .na \fB\fB-x\fR\fR .ad .RS 12n -.rt Only display status for pools that are exhibiting errors or are otherwise unavailable. Warnings about pools not using the latest on-disk format will not be included. .RE .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad .RS 12n -.rt Display a histogram of deduplication statistics, showing the allocated (physically present on disk) and referenced (logically referenced in the pool) block counts and sizes by reference count. .RE .sp .ne 2 -.mk .na \fB\fB-T\fR \fBd\fR | \fBu\fR\fR .ad .RS 12n -.rt Display a time stamp. .sp Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See \fBdate\fR(1). @@ -2410,7 +2171,6 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR\fR .ad @@ -2421,7 +2181,6 @@ Displays pools which do not have all supported features enabled and pools format .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR \fB-v\fR\fR .ad @@ -2432,7 +2191,6 @@ Displays legacy \fBZFS\fR versions supported by the current software. See \fBzfs .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR .ad @@ -2441,23 +2199,19 @@ Displays legacy \fBZFS\fR versions supported by the current software. See \fBzfs Enables all supported features on the given pool. Once this is done, the pool will no longer be accessible on systems that do not support feature flags. See \fBzfs-features\fR(5) for details on compatibility with systems that support feature flags, but do not support all features enabled on the pool. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 14n -.rt Enables all supported features on all pools. .RE .sp .ne 2 -.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad .RS 14n -.rt Upgrade to the specified legacy version. If the \fB-V\fR flag is specified, no features will be enabled on the pool. This option can only be used to increase the version number up to the last supported legacy version number. .RE @@ -2783,34 +2537,28 @@ data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE - The following exit values are returned: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad .RS 5n -.rt Successful completion. .RE .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad .RS 5n -.rt An error occurred. .RE .sp .ne 2 -.mk .na \fB\fB2\fR\fR .ad .RS 5n -.rt Invalid command line options were specified. .RE