diff options
| author | Matt Macy <mmacy@FreeBSD.org> | 2021-01-07 23:19:59 +0000 |
|---|---|---|
| committer | Matt Macy <mmacy@FreeBSD.org> | 2021-01-07 23:19:59 +0000 |
| commit | 42385c279bad198701badabdab661df49f2acb9a (patch) | |
| tree | 529931aeb217bb13f5cbfb4eb38fd75163d251ba /man | |
| parent | 0be360124f8f108f73365e31448e7550f877f3ac (diff) | |
| download | src-vendor/openzfs/20210107.tar.gz src-vendor/openzfs/20210107.zip | |
Update OpenZFS to master-f11b09vendor/openzfs/20210107
Diffstat (limited to 'man')
63 files changed, 744 insertions, 283 deletions
diff --git a/man/man1/arcstat.1 b/man/man1/arcstat.1 index 7fe1e0bfb14a..de63206e279f 100644 --- a/man/man1/arcstat.1 +++ b/man/man1/arcstat.1 @@ -13,13 +13,13 @@ .\" Copyright (c) 2015 by Delphix. All rights reserved. .\" Copyright (c) 2020 by AJ Jordan. All rights reserved. .\" -.TH ARCSTAT 1 "Aug 24, 2020" OpenZFS +.TH ARCSTAT 1 "Oct 20, 2020" OpenZFS .SH NAME arcstat \- report ZFS ARC and L2ARC statistics .SH SYNOPSIS .LP .nf -\fBarcstat\fR [\fB-hvx\fR] [\fB-f field[,field]...\fR] [\fB-o file\fR] [\fB-s string\fR] [\fBinterval\fR [\fBcount\fR]] +\fBarcstat\fR [\fB-havxp\fR] [\fB-f field[,field]...\fR] [\fB-o file\fR] [\fB-s string\fR] [\fBinterval\fR [\fBcount\fR]] .fi .SH DESCRIPTION @@ -335,6 +335,96 @@ Total L2ARC accesses per second .sp .ne 2 .na +\fBl2pref \fR +.ad +.RS 14n +L2ARC prefetch allocated size per second +.RE + +.sp +.ne 2 +.na +\fBl2pref% \fR +.ad +.RS 14n +L2ARC prefetch allocated size percentage +.RE + +.sp +.ne 2 +.na +\fBl2mfu \fR +.ad +.RS 14n +L2ARC MFU allocated size per second +.RE + +.sp +.ne 2 +.na +\fBl2mfu% \fR +.ad +.RS 14n +L2ARC MFU allocated size percentage +.RE + +.sp +.ne 2 +.na +\fBl2mru \fR +.ad +.RS 14n +L2ARC MRU allocated size per second +.RE + +.sp +.ne 2 +.na +\fBl2mru% \fR +.ad +.RS 14n +L2ARC MRU allocated size percentage +.RE + +.sp +.ne 2 +.na +\fBl2data \fR +.ad +.RS 14n +L2ARC data (buf content) allocated size per second +.RE + +.sp +.ne 2 +.na +\fBl2data% \fR +.ad +.RS 14n +L2ARC data (buf content) allocated size percentage +.RE + +.sp +.ne 2 +.na +\fBl2meta \fR +.ad +.RS 14n +L2ARC metadata (buf content) allocated size per second +.RE + +.sp +.ne 2 +.na +\fBl2meta% \fR +.ad +.RS 14n +L2ARC metadata (buf content) allocated size percentage +.RE + +.sp +.ne 2 +.na \fBl2size \fR .ad .RS 14n @@ -423,6 +513,15 @@ The following options are supported: .sp .ne 2 .na +\fB\fB-a\fR\fR +.ad +.RS 12n +Print all possible stats. +.RE + +.sp +.ne 2 +.na \fB\fB-f\fR\fR .ad .RS 12n @@ -450,6 +549,15 @@ Report statistics to a file instead of the standard output. .sp .ne 2 .na +\fB\fB-p\fR\fR +.ad +.RS 12n +Disable auto-scaling of numerical fields (for raw, machine-parsable values). +.RE + +.sp +.ne 2 +.na \fB\fB-s\fR\fR .ad .RS 12n diff --git a/man/man1/raidz_test.1 b/man/man1/raidz_test.1 index 94e48bf49bd7..26e6b24ad815 100644 --- a/man/man1/raidz_test.1 +++ b/man/man1/raidz_test.1 @@ -61,6 +61,11 @@ during testing. .IP Size of data for raidz block. Size is 1 << (zio_size_shift). .HP +.BI "\-r" " reflow_offset" " (default: uint max)" +.IP +Set raidz expansion offset. The expanded raidz map allocation function will +produce different map configurations depending on this value. +.HP .BI "\-S(weep)" .IP Sweep parameter space while verifying the raidz implementations. This option @@ -77,6 +82,10 @@ This options starts the benchmark mode. All implementations are benchmarked using increasing per disk data size. Results are given as throughput per disk, measured in MiB/s. .HP +.BI "\-e(xpansion)" +.IP +Use expanded raidz map allocation function. +.HP .BI "\-v(erbose)" .IP Increase verbosity. diff --git a/man/man1/ztest.1 b/man/man1/ztest.1 index 68c978ca0968..3f30b3ed743d 100644 --- a/man/man1/ztest.1 +++ b/man/man1/ztest.1 @@ -23,6 +23,7 @@ .\" Copyright (c) 2009 Oracle and/or its affiliates. All rights reserved. .\" Copyright (c) 2009 Michael Gebetsroither <michael.geb@gmx.at>. All rights .\" reserved. +.\" Copyright (c) 2017, Intel Corporation. .\" .TH ZTEST 1 "Aug 24, 2020" OpenZFS @@ -82,13 +83,29 @@ Used alignment in test. .IP Number of mirror copies. .HP -.BI "\-r" " raidz_disks" " (default: 4)" +.BI "\-r" " raidz_disks / draid_disks" " (default: 4 / 16)" .IP Number of raidz disks. .HP -.BI "\-R" " raidz_parity" " (default: 1)" +.BI "\-R" " raid_parity" " (default: 1)" .IP -Raidz parity. +Raid parity (raidz & draid). +.HP +.BI "\-K" " raid_kind" " (default: 'random') raidz|draid|random" +.IP +The kind of RAID config to use. With 'random' the kind alternates between raidz and draid. +.HP +.BI "\-D" " draid_data" " (default: 4)" +.IP +Number of data disks in a dRAID redundancy group. +.HP +.BI "\-S" " draid_spares" " (default: 1)" +.IP +Number of dRAID distributed spare disks. +.HP +.BI "\-C" " vdev_class_state" " (default: random)" +.IP +The vdev allocation class state: special=on|off|random. .HP .BI "\-d" " datasets" " (default: 7)" .IP diff --git a/man/man5/zfs-module-parameters.5 b/man/man5/zfs-module-parameters.5 index 1b1a0d56a3ab..41e8ffa79585 100644 --- a/man/man5/zfs-module-parameters.5 +++ b/man/man5/zfs-module-parameters.5 @@ -209,7 +209,19 @@ This may be desired to avoid wasting space on L2ARC when reading/writing large amounts of data that are not expected to be accessed more than once. The default is \fB0\fR, meaning both MRU and MFU data and metadata are cached. When turning off (\fB0\fR) this feature some MRU buffers will still be present -in ARC and eventually cached on L2ARC. +in ARC and eventually cached on L2ARC. If \fBl2arc_noprefetch\fR is set to 0, +some prefetched buffers will be cached to L2ARC, and those might later +transition to MRU, in which case the \fBl2arc_mru_asize\fR arcstat will not +be 0. Regardless of \fBl2arc_noprefetch\fR, some MFU buffers might be evicted +from ARC, accessed later on as prefetches and transition to MRU as prefetches. +If accessed again they are counted as MRU and the \fBl2arc_mru_asize\fR arcstat +will not be 0. The ARC status of L2ARC buffers when they were first cached in +L2ARC can be seen in the \fBl2arc_mru_asize\fR, \fBl2arc_mfu_asize\fR and +\fBl2arc_prefetch_asize\fR arcstats when importing the pool or onlining a cache +device if persistent L2ARC is enabled. The \fBevicted_l2_eligible_mru\fR +arcstat does not take into account if this option is enabled as the information +provided by the evicted_l2_eligible_* arcstats can be used to decide if +toggling this option is appropriate for the current workload. .sp Use \fB0\fR for no (default) and \fB1\fR for yes. .RE @@ -254,9 +266,15 @@ Default value: \fB0\fR%. .ad .RS 12n Do not write buffers to L2ARC if they were prefetched but not used by -applications. +applications. In case there are prefetched buffers in L2ARC and this option +is later set to \fB1\fR, we do not read the prefetched buffers from L2ARC. +Setting this option to \fB0\fR is useful for caching sequential reads from the +disks to L2ARC and serve those reads from L2ARC later on. This may be beneficial +in case the L2ARC device is significantly faster in sequential reads than the +disks of the pool. .sp -Use \fB1\fR for yes (default) and \fB0\fR to disable. +Use \fB1\fR to disable (default) and \fB0\fR to enable caching/reading +prefetches to/from L2ARC.. .RE .sp @@ -364,6 +382,20 @@ Default value: \fB16,777,217\fR. .sp .ne 2 .na +\fBzfs_history_output_max\fR (int) +.ad +.RS 12n +When attempting to log the output nvlist of an ioctl in the on-disk history, the +output will not be stored if it is larger than size (in bytes). This must be +less then DMU_MAX_ACCESS (64MB). This applies primarily to +zfs_ioc_channel_program(). +.sp +Default value: \fB1MB\fR. +.RE + +.sp +.ne 2 +.na \fBzfs_keep_log_spacemaps_at_export\fR (int) .ad .RS 12n @@ -497,6 +529,40 @@ Default value: \fB25 percent\fR .sp .ne 2 .na +\fBzfs_metaslab_try_hard_before_gang\fR (int) +.ad +.RS 12n +If not set (the default), we will first try normal allocation. +If that fails then we will do a gang allocation. +If that fails then we will do a "try hard" gang allocation. +If that fails then we will have a multi-layer gang block. +.sp +If set, we will first try normal allocation. +If that fails then we will do a "try hard" allocation. +If that fails we will do a gang allocation. +If that fails we will do a "try hard" gang allocation. +If that fails then we will have a multi-layer gang block. +.sp +Default value: \fB0 (false)\fR +.RE + +.sp +.ne 2 +.na +\fBzfs_metaslab_find_max_tries\fR (int) +.ad +.RS 12n +When not trying hard, we only consider this number of the best metaslabs. +This improves performance, especially when there are many metaslabs per vdev +and the allocation can't actually be satisfied (so we would otherwise iterate +all the metaslabs). +.sp +Default value: \fB100\fR +.RE + +.sp +.ne 2 +.na \fBzfs_vdev_default_ms_count\fR (int) .ad .RS 12n @@ -1997,8 +2063,7 @@ Default value: \fB1\fR. .ad .RS 12n The maximum number of I/Os active to each device. Ideally, this will be >= -the sum of each queue's max_active. It must be at least the sum of each -queue's min_active. See the section "ZFS I/O SCHEDULER". +the sum of each queue's max_active. See the section "ZFS I/O SCHEDULER". .sp Default value: \fB1,000\fR. .RE @@ -2150,6 +2215,42 @@ Default value: \fB1\fR. .sp .ne 2 .na +\fBzfs_vdev_nia_delay\fR (int) +.ad +.RS 12n +For non-interactive I/O (scrub, resilver, removal, initialize and rebuild), +the number of concurrently-active I/O's is limited to *_min_active, unless +the vdev is "idle". When there are no interactive I/Os active (sync or +async), and zfs_vdev_nia_delay I/Os have completed since the last +interactive I/O, then the vdev is considered to be "idle", and the number +of concurrently-active non-interactive I/O's is increased to *_max_active. +See the section "ZFS I/O SCHEDULER". +.sp +Default value: \fB5\fR. +.RE + +.sp +.ne 2 +.na +\fBzfs_vdev_nia_credit\fR (int) +.ad +.RS 12n +Some HDDs tend to prioritize sequential I/O so high, that concurrent +random I/O latency reaches several seconds. On some HDDs it happens +even if sequential I/Os are submitted one at a time, and so setting +*_max_active to 1 does not help. To prevent non-interactive I/Os, like +scrub, from monopolizing the device no more than zfs_vdev_nia_credit +I/Os can be sent while there are outstanding incomplete interactive +I/Os. This enforced wait ensures the HDD services the interactive I/O +within a reasonable amount of time. +See the section "ZFS I/O SCHEDULER". +.sp +Default value: \fB5\fR. +.RE + +.sp +.ne 2 +.na \fBzfs_vdev_queue_depth_pct\fR (int) .ad .RS 12n @@ -2887,6 +2988,31 @@ Default value: \fB1,048,576\fR. .sp .ne 2 .na +\fBzfs_rebuild_scrub_enabled\fR (int) +.ad +.RS 12n +Automatically start a pool scrub when the last active sequential resilver +completes in order to verify the checksums of all blocks which have been +resilvered. This option is enabled by default and is strongly recommended. +.sp +Default value: \fB1\fR. +.RE + +.sp +.ne 2 +.na +\fBzfs_rebuild_vdev_limit\fR (ulong) +.ad +.RS 12n +Maximum amount of i/o that can be concurrently issued for a sequential +resilver per leaf device, given in bytes. +.sp +Default value: \fB33,554,432\fR. +.RE + +.sp +.ne 2 +.na \fBzfs_reconstruct_indirect_combinations_max\fR (int) .ad .RS 12na diff --git a/man/man5/zpool-features.5 b/man/man5/zpool-features.5 index 36c4343a1388..2e5ab4c37642 100644 --- a/man/man5/zpool-features.5 +++ b/man/man5/zpool-features.5 @@ -309,6 +309,30 @@ on a top-level vdev, and will never return to being \fBenabled\fR. .sp .ne 2 .na +\fBdraid\fR +.ad +.RS 4n +.TS +l l . +GUID org.openzfs:draid +READ\-ONLY COMPATIBLE no +DEPENDENCIES none +.TE + +This feature enables use of the \fBdraid\fR vdev type. dRAID is a variant +of raidz which provides integrated distributed hot spares that allow faster +resilvering while retaining the benefits of raidz. Data, parity, and spare +space are organized in redundancy groups and distributed evenly over all of +the devices. + +This feature becomes \fBactive\fR when creating a pool which uses the +\fBdraid\fR vdev type, or when adding a new \fBdraid\fR vdev to an +existing pool. +.RE + +.sp +.ne 2 +.na \fBedonr\fR .ad .RS 4n @@ -676,11 +700,11 @@ When the \fBmulti_vdev_crash_dump\fR feature is set to \fBenabled\fR, the administrator can use the \fBdumpadm\fR(1M) command to configure a dump device on a pool comprised of multiple vdevs. -Under Linux this feature is registered for compatibility but not used. -New pools created under Linux will have the feature \fBenabled\fR but -will never transition to \fB\fBactive\fR. This functionality is not -required in order to support crash dumps under Linux. Existing pools -where this feature is \fB\fBactive\fR can be imported. +Under FreeBSD and Linux this feature is registered for compatibility but not +used. New pools created under FreeBSD and Linux will have the feature +\fBenabled\fR but will never transition to \fB\fBactive\fR. This functionality +is not required in order to support crash dumps under FreeBSD and Linux. +Existing pools where this feature is \fB\fBactive\fR can be imported. .RE .sp diff --git a/man/man8/Makefile.am b/man/man8/Makefile.am index 07f6aefa68e6..602645180beb 100644 --- a/man/man8/Makefile.am +++ b/man/man8/Makefile.am @@ -82,7 +82,8 @@ dist_man_MANS = \ zpool-upgrade.8 \ zpool-wait.8 \ zstream.8 \ - zstreamdump.8 + zstreamdump.8 \ + zpool_influxdb.8 nodist_man_MANS = \ zed.8 \ diff --git a/man/man8/zfs-allow.8 b/man/man8/zfs-allow.8 index f32b29a72661..ac4bf658b92a 100644 --- a/man/man8/zfs-allow.8 +++ b/man/man8/zfs-allow.8 @@ -34,57 +34,57 @@ .Dt ZFS-ALLOW 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm allow +.Nm zfs-allow .Nd Delegates ZFS administration permission for the file systems to non-privileged users. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm allow .Op Fl dglu .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ... .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm allow .Op Fl dl .Fl e Ns | Ns Sy everyone .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm allow .Fl c .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm allow .Fl s No @ Ns Ar setname .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm unallow .Op Fl dglru .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ... .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... Oc .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm unallow .Op Fl dlr .Fl e Ns | Ns Sy everyone .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... Oc .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm unallow .Op Fl r .Fl c .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns .Ar setname Oc Ns ... Oc .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm unallow .Op Fl r .Fl s No @ Ns Ar setname @@ -94,7 +94,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm allow .Ar filesystem Ns | Ns Ar volume .Xc @@ -116,7 +116,7 @@ These permissions cannot be delegated because the Linux .Xr mount 8 command restricts modifications of the global namespace to the root user. .It Xo -.Nm +.Nm zfs .Cm allow .Op Fl dglu .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ... @@ -125,7 +125,7 @@ command restricts modifications of the global namespace to the root user. .Ar filesystem Ns | Ns Ar volume .Xc .It Xo -.Nm +.Nm zfs .Cm allow .Op Fl dl .Fl e Ns | Ns Sy everyone @@ -271,7 +271,7 @@ xattr property zoned property .Ed .It Xo -.Nm +.Nm zfs .Cm allow .Fl c .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns @@ -285,7 +285,7 @@ These permissions are granted .Pq locally to the creator of any newly-created descendent file system. .It Xo -.Nm +.Nm zfs .Cm allow .Fl s No @ Ns Ar setname .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns @@ -302,7 +302,7 @@ name must begin with .Sy @ , and can be no more than 64 characters long. .It Xo -.Nm +.Nm zfs .Cm unallow .Op Fl dglru .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ... @@ -311,7 +311,7 @@ and can be no more than 64 characters long. .Ar filesystem Ns | Ns Ar volume .Xc .It Xo -.Nm +.Nm zfs .Cm unallow .Op Fl dlr .Fl e Ns | Ns Sy everyone @@ -320,7 +320,7 @@ and can be no more than 64 characters long. .Ar filesystem Ns | Ns Ar volume .Xc .It Xo -.Nm +.Nm zfs .Cm unallow .Op Fl r .Fl c @@ -358,7 +358,7 @@ options. Recursively remove the permissions from this file system and all descendents. .El .It Xo -.Nm +.Nm zfs .Cm unallow .Op Fl r .Fl s No @ Ns Ar setname diff --git a/man/man8/zfs-bookmark.8 b/man/man8/zfs-bookmark.8 index 3b2af815920d..042ddf504435 100644 --- a/man/man8/zfs-bookmark.8 +++ b/man/man8/zfs-bookmark.8 @@ -35,13 +35,13 @@ .Dt ZFS-BOOKMARK 8 SMM .Os .Sh NAME -.Nm zfs Ns Pf - Cm bookmark +.Nm zfs-bookmark .Nd Creates a bookmark of the given snapshot. .Sh SYNOPSIS .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm bookmark .Ar snapshot Ns | Ns Ar bookmark newbookmark .Xc diff --git a/man/man8/zfs-clone.8 b/man/man8/zfs-clone.8 index 352a2392ff40..9cb84d3c56d6 100644 --- a/man/man8/zfs-clone.8 +++ b/man/man8/zfs-clone.8 @@ -34,10 +34,10 @@ .Dt ZFS-CLONE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm clone +.Nm zfs-clone .Nd Creates a clone of the given snapshot. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm clone .Op Fl p .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... @@ -45,7 +45,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm clone .Op Fl p .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... diff --git a/man/man8/zfs-create.8 b/man/man8/zfs-create.8 index c37d63305a4e..5a4f9a32afa5 100644 --- a/man/man8/zfs-create.8 +++ b/man/man8/zfs-create.8 @@ -30,19 +30,19 @@ .\" Copyright 2018 Nexenta Systems, Inc. .\" Copyright 2019 Joyent, Inc. .\" -.Dd June 30, 2019 +.Dd December 1, 2020 .Dt ZFS-CREATE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm create +.Nm zfs-create .Nd Creates a new ZFS file system. .Sh SYNOPSIS .Nm zfs .Cm create -.Op Fl Pnpv +.Op Fl Pnpuv .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... .Ar filesystem -.Nm +.Nm zfs .Cm create .Op Fl ps .Op Fl b Ar blocksize @@ -51,16 +51,18 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm create -.Op Fl Pnpv +.Op Fl Pnpuv .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... .Ar filesystem .Xc Creates a new ZFS file system. The file system is automatically mounted according to the .Sy mountpoint -property inherited from the parent. +property inherited from the parent, unless the +.Fl u +option is used. .Bl -tag -width "-o" .It Fl o Ar property Ns = Ns Ar value Sets the specified property as if the command @@ -122,11 +124,13 @@ to due to the use of the .Fl o option. +.It Fl u +Do not mount the newly created file system. .It Fl v Print verbose information about the created dataset. .El .It Xo -.Nm +.Nm zfs .Cm create .Op Fl ps .Op Fl b Ar blocksize diff --git a/man/man8/zfs-destroy.8 b/man/man8/zfs-destroy.8 index 99ae33d5ecf4..b0365cc82a91 100644 --- a/man/man8/zfs-destroy.8 +++ b/man/man8/zfs-destroy.8 @@ -34,25 +34,25 @@ .Dt ZFS-DESTROY 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm destroy +.Nm zfs-destroy .Nd Destroys the given dataset(s), snapshot(s), or bookmark. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm destroy .Op Fl Rfnprv .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm destroy .Op Fl Rdnprv .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ... -.Nm +.Nm zfs .Cm destroy .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm destroy .Op Fl Rfnprv .Ar filesystem Ns | Ns Ar volume @@ -96,7 +96,7 @@ or the options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use. .It Xo -.Nm +.Nm zfs .Cm destroy .Op Fl Rdnprv .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns @@ -167,7 +167,7 @@ options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use. .El .It Xo -.Nm +.Nm zfs .Cm destroy .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark .Xc diff --git a/man/man8/zfs-diff.8 b/man/man8/zfs-diff.8 index bcc12f7cbba7..c7b9e138d849 100644 --- a/man/man8/zfs-diff.8 +++ b/man/man8/zfs-diff.8 @@ -34,17 +34,17 @@ .Dt ZFS-DIFF 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm diff +.Nm zfs-diff .Nd Display the difference between two snapshots of a given filesystem. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm diff .Op Fl FHt .Ar snapshot Ar snapshot Ns | Ns Ar filesystem .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm diff .Op Fl FHt .Ar snapshot Ar snapshot Ns | Ns Ar filesystem @@ -66,7 +66,7 @@ R The path has been renamed .Bl -tag -width "-F" .It Fl F Display an indication of the type of file, in a manner similar to the -.Fl +.Fl F option of .Xr ls 1 . .Bd -literal diff --git a/man/man8/zfs-hold.8 b/man/man8/zfs-hold.8 index de30caab153a..ac56fc4a434a 100644 --- a/man/man8/zfs-hold.8 +++ b/man/man8/zfs-hold.8 @@ -34,25 +34,25 @@ .Dt ZFS-HOLD 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm hold +.Nm zfs-hold .Nd Hold a snapshot to prevent it being removed with the zfs destroy command. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm hold .Op Fl r .Ar tag Ar snapshot Ns ... -.Nm +.Nm zfs .Cm holds .Op Fl rH .Ar snapshot Ns ... -.Nm +.Nm zfs .Cm release .Op Fl r .Ar tag Ar snapshot Ns ... .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm hold .Op Fl r .Ar tag Ar snapshot Ns ... @@ -73,7 +73,7 @@ Specifies that a hold with the given tag is applied recursively to the snapshots of all descendent file systems. .El .It Xo -.Nm +.Nm zfs .Cm holds .Op Fl rH .Ar snapshot Ns ... @@ -87,7 +87,7 @@ listing the holds on the named snapshot. Do not print headers, use tab-delimited output. .El .It Xo -.Nm +.Nm zfs .Cm release .Op Fl r .Ar tag Ar snapshot Ns ... diff --git a/man/man8/zfs-jail.8 b/man/man8/zfs-jail.8 index 8274179bb089..4c439d53f0d6 100644 --- a/man/man8/zfs-jail.8 +++ b/man/man8/zfs-jail.8 @@ -41,7 +41,7 @@ .Dt ZFS-JAIL 8 .Os FreeBSD .Sh NAME -.Nm zfs Ns Pf - Cm jail +.Nm zfs-jail .Nd Attaches and detaches ZFS filesystems from FreeBSD jails. .No A Tn ZFS dataset can be attached to a jail by using the @@ -72,16 +72,16 @@ After a dataset is attached to a jail and the jailed property is set, a jailed file system cannot be mounted outside the jail, since the jail administrator might have set the mount point to an unacceptable value. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm jail .Ar jailid Ns | Ns Ar jailname filesystem -.Nm +.Nm zfs .Cm unjail .Ar jailid Ns | Ns Ar jailname filesystem .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm jail .Ar jailid filesystem .Xc @@ -104,7 +104,7 @@ See .Xr jail 8 for more information on managing jails and configuring the parameters above. .It Xo -.Nm +.Nm zfs .Cm unjail .Ar jailid filesystem .Xc diff --git a/man/man8/zfs-list.8 b/man/man8/zfs-list.8 index ad2b57e6d664..e6db73631f5c 100644 --- a/man/man8/zfs-list.8 +++ b/man/man8/zfs-list.8 @@ -34,10 +34,10 @@ .Dt ZFS-LIST 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm list +.Nm zfs-list .Nd Lists the property information for the given datasets in tabular form. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm list .Op Fl r Ns | Ns Fl d Ar depth .Op Fl Hp @@ -49,7 +49,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm list .Op Fl r Ns | Ns Fl d Ar depth .Op Fl Hp diff --git a/man/man8/zfs-load-key.8 b/man/man8/zfs-load-key.8 index 72248b6962d9..7d273ddd53b0 100644 --- a/man/man8/zfs-load-key.8 +++ b/man/man8/zfs-load-key.8 @@ -34,26 +34,26 @@ .Dt ZFS-LOAD-KEY 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm load-key +.Nm zfs-load-key .Nd Load, unload, or change the encryption key used to access a dataset. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm load-key .Op Fl nr .Op Fl L Ar keylocation .Fl a | Ar filesystem -.Nm +.Nm zfs .Cm unload-key .Op Fl r .Fl a | Ar filesystem -.Nm +.Nm zfs .Cm change-key .Op Fl l .Op Fl o Ar keylocation Ns = Ns Ar value .Op Fl o Ar keyformat Ns = Ns Ar value .Op Fl o Ar pbkdf2iters Ns = Ns Ar value .Ar filesystem -.Nm +.Nm zfs .Cm change-key .Fl i .Op Fl l @@ -61,7 +61,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm load-key .Op Fl nr .Op Fl L Ar keylocation @@ -118,7 +118,7 @@ may only be given as .Sy prompt . .El .It Xo -.Nm +.Nm zfs .Cm unload-key .Op Fl r .Fl a | Ar filesystem @@ -139,7 +139,7 @@ encryption roots. Unloads the keys for all encryption roots in all imported pools. .El .It Xo -.Nm +.Nm zfs .Cm change-key .Op Fl l .Op Fl o Ar keylocation Ns = Ns Ar value @@ -148,7 +148,7 @@ Unloads the keys for all encryption roots in all imported pools. .Ar filesystem .Xc .It Xo -.Nm +.Nm zfs .Cm change-key .Fl i .Op Fl l diff --git a/man/man8/zfs-mount.8 b/man/man8/zfs-mount.8 index feddafb28e2f..00fb37c786e1 100644 --- a/man/man8/zfs-mount.8 +++ b/man/man8/zfs-mount.8 @@ -34,29 +34,29 @@ .Dt ZFS-MOUNT 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm mount +.Nm zfs-mount .Nd Manage mount state of ZFS file systems. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm mount -.Nm +.Nm zfs .Cm mount .Op Fl Oflv .Op Fl o Ar options .Fl a | Ar filesystem -.Nm +.Nm zfs .Cm unmount .Op Fl fu .Fl a | Ar filesystem Ns | Ns Ar mountpoint .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm mount .Xc Displays all ZFS file systems currently mounted. .It Xo -.Nm +.Nm zfs .Cm mount .Op Fl Oflv .Op Fl o Ar options @@ -105,7 +105,7 @@ Report mount progress. Attempt to force mounting of all filesystems, even those that couldn't normally be mounted (e.g. redacted datasets). .El .It Xo -.Nm +.Nm zfs .Cm unmount .Op Fl fu .Fl a | Ar filesystem Ns | Ns Ar mountpoint diff --git a/man/man8/zfs-program.8 b/man/man8/zfs-program.8 index 41d38587e547..b08c94916de6 100644 --- a/man/man8/zfs-program.8 +++ b/man/man8/zfs-program.8 @@ -16,10 +16,11 @@ .Dt ZFS-PROGRAM 8 .Os .Sh NAME -.Nm zfs program +.Nm zfs-program .Nd executes ZFS channel programs .Sh SYNOPSIS -.Cm "zfs program" +.Nm zfs +.Cm program .Op Fl jn .Op Fl t Ar instruction-limit .Op Fl m Ar memory-limit diff --git a/man/man8/zfs-project.8 b/man/man8/zfs-project.8 index d3171c05c5bc..21c300f83df1 100644 --- a/man/man8/zfs-project.8 +++ b/man/man8/zfs-project.8 @@ -34,26 +34,26 @@ .Dt ZFS-PROJECT 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm project +.Nm zfs-project .Nd List, set, or clear project ID and/or inherit flag on the file(s) or directories. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm project .Oo Fl d Ns | Ns Fl r Ns Oc .Ar file Ns | Ns Ar directory Ns ... -.Nm +.Nm zfs .Cm project .Fl C .Oo Fl kr Ns Oc .Ar file Ns | Ns Ar directory Ns ... -.Nm +.Nm zfs .Cm project .Fl c .Oo Fl 0 Ns Oc .Oo Fl d Ns | Ns Fl r Ns Oc .Op Fl p Ar id .Ar file Ns | Ns Ar directory Ns ... -.Nm +.Nm zfs .Cm project .Op Fl p Ar id .Oo Fl rs Ns Oc @@ -61,7 +61,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm project .Oo Fl d Ns | Ns Fl r Ns Oc .Ar file Ns | Ns Ar directory Ns ... @@ -79,7 +79,7 @@ Show on subdirectories recursively. It will overwrite the former specified option. .El .It Xo -.Nm +.Nm zfs .Cm project .Fl C .Oo Fl kr Ns Oc @@ -94,7 +94,7 @@ as zero. Clear on subdirectories recursively. .El .It Xo -.Nm +.Nm zfs .Cm project .Fl c .Oo Fl 0 Ns Oc @@ -126,7 +126,7 @@ Check on subdirectories recursively. It will overwrite the former specified option. .El .It Xo -.Nm +.Nm zfs .Cm project .Op Fl p Ar id .Oo Fl rs Ns Oc diff --git a/man/man8/zfs-promote.8 b/man/man8/zfs-promote.8 index 08cd8b2b94f2..64c124c11b61 100644 --- a/man/man8/zfs-promote.8 +++ b/man/man8/zfs-promote.8 @@ -34,16 +34,16 @@ .Dt ZFS-PROMOTE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm promote +.Nm zfs-promote .Nd Promotes a clone file system to no longer be dependent on its origin snapshot. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm promote .Ar clone-filesystem .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm promote .Ar clone-filesystem .Xc diff --git a/man/man8/zfs-receive.8 b/man/man8/zfs-receive.8 index 3cd17fea4a2d..ed5cbbdf0b79 100644 --- a/man/man8/zfs-receive.8 +++ b/man/man8/zfs-receive.8 @@ -34,17 +34,17 @@ .Dt ZFS-RECEIVE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm receive +.Nm zfs-receive .Nd Creates a snapshot whose contents are as specified in the stream provided on standard input. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm receive .Op Fl FhMnsuv .Op Fl o Sy origin Ns = Ns Ar snapshot .Op Fl o Ar property Ns = Ns Ar value .Op Fl x Ar property .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot -.Nm +.Nm zfs .Cm receive .Op Fl FhMnsuv .Op Fl d Ns | Ns Fl e @@ -52,14 +52,14 @@ .Op Fl o Ar property Ns = Ns Ar value .Op Fl x Ar property .Ar filesystem -.Nm +.Nm zfs .Cm receive .Fl A .Ar filesystem Ns | Ns Ar volume .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm receive .Op Fl FhMnsuv .Op Fl o Sy origin Ns = Ns Ar snapshot @@ -68,7 +68,7 @@ .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot .Xc .It Xo -.Nm +.Nm zfs .Cm receive .Op Fl FhMnsuv .Op Fl d Ns | Ns Fl e @@ -290,7 +290,7 @@ receive. This allows unencrypted streams to be received as encrypted datasets. To cause the received dataset (or root dataset of a recursive stream) to be received as an encryption root, specify encryption properties in the same manner as is required for -.Nm +.Nm zfs .Cm create . For instance: .Bd -literal @@ -301,7 +301,7 @@ Note that .Op Fl o Ar keylocation Ns = Ns Ar prompt may not be specified here, since stdin is already being utilized for the send stream. Once the receive has completed, you can use -.Nm +.Nm zfs .Cm set to change this setting after the fact. Similarly, you can receive a dataset as an encrypted child by specifying @@ -361,7 +361,7 @@ restrictions (e.g. set-once) apply equally to .Fl x . .El .It Xo -.Nm +.Nm zfs .Cm receive .Fl A .Ar filesystem Ns | Ns Ar volume diff --git a/man/man8/zfs-rename.8 b/man/man8/zfs-rename.8 index 78bd8934a00f..f57bcd8441f4 100644 --- a/man/man8/zfs-rename.8 +++ b/man/man8/zfs-rename.8 @@ -34,40 +34,40 @@ .Dt ZFS-RENAME 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm rename +.Nm zfs-rename .Nd Renames the given dataset (filesystem or snapshot). .Sh SYNOPSIS -.Nm +.Nm zfs .Cm rename .Op Fl f .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot -.Nm +.Nm zfs .Cm rename .Fl p .Op Fl f .Ar filesystem Ns | Ns Ar volume .Ar filesystem Ns | Ns Ar volume -.Nm +.Nm zfs .Cm rename .Fl u .Op Fl f .Ar filesystem Ar filesystem -.Nm +.Nm zfs .Cm rename .Fl r .Ar snapshot Ar snapshot .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm rename .Op Fl f .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot .Xc .It Xo -.Nm +.Nm zfs .Cm rename .Fl p .Op Fl f @@ -75,7 +75,7 @@ .Ar filesystem Ns | Ns Ar volume .Xc .It Xo -.Nm +.Nm zfs .Cm rename .Fl u .Op Fl f @@ -112,7 +112,7 @@ or the file system is not unmounted even if this option is not given. .El .It Xo -.Nm +.Nm zfs .Cm rename .Fl r .Ar snapshot Ar snapshot diff --git a/man/man8/zfs-rollback.8 b/man/man8/zfs-rollback.8 index 1078efd8a4b7..8a7cb6621fae 100644 --- a/man/man8/zfs-rollback.8 +++ b/man/man8/zfs-rollback.8 @@ -34,17 +34,17 @@ .Dt ZFS-ROLLBACK 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm rollback +.Nm zfs-rollback .Nd Roll back the given dataset to a previous snapshot. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm rollback .Op Fl Rfr .Ar snapshot .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm rollback .Op Fl Rfr .Ar snapshot diff --git a/man/man8/zfs-send.8 b/man/man8/zfs-send.8 index 8b7f940eb793..1a241a52d54b 100644 --- a/man/man8/zfs-send.8 +++ b/man/man8/zfs-send.8 @@ -34,43 +34,43 @@ .Dt ZFS-SEND 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm send +.Nm zfs-send .Nd Generate a send stream, which may be of a filesystem, and may be incremental from a bookmark. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm send .Op Fl DLPRbcehnpvw .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot .Ar snapshot -.Nm +.Nm zfs .Cm send .Op Fl DLPRcenpvw .Op Fl i Ar snapshot Ns | Ns Ar bookmark .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot -.Nm +.Nm zfs .Cm send .Fl -redact Ar redaction_bookmark .Op Fl DLPcenpv .br .Op Fl i Ar snapshot Ns | Ns Ar bookmark .Ar snapshot -.Nm +.Nm zfs .Cm send .Op Fl Penv .Fl t .Ar receive_resume_token -.Nm +.Nm zfs .Cm send .Op Fl Pnv .Fl S Ar filesystem -.Nm +.Nm zfs .Cm redact .Ar snapshot redaction_bookmark .Ar redaction_snapshot Ns ... .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm send .Op Fl DLPRbcehnpvw .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot @@ -266,7 +266,7 @@ The format of the stream is committed. You will be able to receive your streams on future versions of ZFS. .El .It Xo -.Nm +.Nm zfs .Cm send .Op Fl DLPRcenpvw .Op Fl i Ar snapshot Ns | Ns Ar bookmark @@ -391,7 +391,7 @@ Print verbose information about the stream package generated. This information includes a per-second report of how much data has been sent. .El .It Xo -.Nm +.Nm zfs .Cm send .Fl -redact Ar redaction_bookmark .Op Fl DLPcenpv @@ -482,7 +482,7 @@ These are stored with the redacted snapshot, and are used to detect and correctly handle the cases above. Note that for technical reasons, raw sends and redacted sends cannot be combined at this time. .It Xo -.Nm +.Nm zfs .Cm send .Op Fl Penv .Fl t @@ -497,7 +497,7 @@ See the documentation for .Sy zfs receive -s for more details. .It Xo -.Nm +.Nm zfs .Cm send .Op Fl Pnv .Op Fl i Ar snapshot Ns | Ns Ar bookmark @@ -514,7 +514,7 @@ always use the last fully received snapshot as the incremental source if it exists. .El .It Xo -.Nm +.Nm zfs .Cm redact .Ar snapshot redaction_bookmark .Ar redaction_snapshot Ns ... diff --git a/man/man8/zfs-set.8 b/man/man8/zfs-set.8 index 5b4348ba94c0..74a7a61d0e29 100644 --- a/man/man8/zfs-set.8 +++ b/man/man8/zfs-set.8 @@ -34,14 +34,14 @@ .Dt ZFS-SET 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm set +.Nm zfs-set .Nd Sets the property or list of properties to the given value(s) for each dataset. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm set .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ... .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... -.Nm +.Nm zfs .Cm get .Op Fl r Ns | Ns Fl d Ar depth .Op Fl Hp @@ -50,14 +50,14 @@ .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ... .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ... -.Nm +.Nm zfs .Cm inherit .Op Fl rS .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm set .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ... .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... @@ -79,7 +79,7 @@ For more information, see the section of .Xr zfsprops 8 . .It Xo -.Nm +.Nm zfs .Cm get .Op Fl r Ns | Ns Fl d Ar depth .Op Fl Hp @@ -160,7 +160,7 @@ or .Sy all . .El .It Xo -.Nm +.Nm zfs .Cm inherit .Op Fl rS .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... diff --git a/man/man8/zfs-share.8 b/man/man8/zfs-share.8 index cb013103371c..ce35accdbf7e 100644 --- a/man/man8/zfs-share.8 +++ b/man/man8/zfs-share.8 @@ -34,19 +34,19 @@ .Dt ZFS-SHARE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm share +.Nm zfs-share .Nd Shares and unshares available ZFS filesystems. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm share .Fl a | Ar filesystem -.Nm +.Nm zfs .Cm unshare .Fl a | Ar filesystem Ns | Ns Ar mountpoint .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm share .Fl a | Ar filesystem .Xc @@ -68,7 +68,7 @@ or property is set. .El .It Xo -.Nm +.Nm zfs .Cm unshare .Fl a | Ar filesystem Ns | Ns Ar mountpoint .Xc diff --git a/man/man8/zfs-snapshot.8 b/man/man8/zfs-snapshot.8 index 618d41d22fe1..b677bc73d2bd 100644 --- a/man/man8/zfs-snapshot.8 +++ b/man/man8/zfs-snapshot.8 @@ -34,10 +34,10 @@ .Dt ZFS-SNAPSHOT 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm snapshot +.Nm zfs-snapshot .Nd Creates snapshots with the given names. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm snapshot .Op Fl r .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... @@ -45,7 +45,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm snapshot .Op Fl r .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... diff --git a/man/man8/zfs-upgrade.8 b/man/man8/zfs-upgrade.8 index 742d5d7bd9e7..6a79f3ea77fd 100644 --- a/man/man8/zfs-upgrade.8 +++ b/man/man8/zfs-upgrade.8 @@ -34,15 +34,15 @@ .Dt ZFS-UPGRADE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm upgrade +.Nm zfs-upgrade .Nd Manage upgrading the on-disk version of filesystems. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm upgrade -.Nm +.Nm zfs .Cm upgrade .Fl v -.Nm +.Nm zfs .Cm upgrade .Op Fl r .Op Fl V Ar version @@ -50,18 +50,18 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm upgrade .Xc Displays a list of file systems that are not the most recent version. .It Xo -.Nm +.Nm zfs .Cm upgrade .Fl v .Xc Displays a list of currently supported file system versions. .It Xo -.Nm +.Nm zfs .Cm upgrade .Op Fl r .Op Fl V Ar version diff --git a/man/man8/zfs-userspace.8 b/man/man8/zfs-userspace.8 index 9c103bf48c04..0a9977a61c6a 100644 --- a/man/man8/zfs-userspace.8 +++ b/man/man8/zfs-userspace.8 @@ -34,10 +34,10 @@ .Dt ZFS-USERSPACE 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm userspace +.Nm zfs-userspace .Nd Displays space consumed by, and quotas on, each user or group in the specified filesystem or snapshot. .Sh SYNOPSIS -.Nm +.Nm zfs .Cm userspace .Op Fl Hinp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc @@ -45,7 +45,7 @@ .Oo Fl S Ar field Oc Ns ... .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path -.Nm +.Nm zfs .Cm groupspace .Op Fl Hinp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc @@ -53,7 +53,7 @@ .Oo Fl S Ar field Oc Ns ... .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path -.Nm +.Nm zfs .Cm projectspace .Op Fl Hp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc @@ -63,7 +63,7 @@ .Sh DESCRIPTION .Bl -tag -width "" .It Xo -.Nm +.Nm zfs .Cm userspace .Op Fl Hinp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc @@ -146,7 +146,7 @@ The default is The default can be changed to include group types. .El .It Xo -.Nm +.Nm zfs .Cm groupspace .Op Fl Hinp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc @@ -162,7 +162,7 @@ This subcommand is identical to except that the default types to display are .Fl t Sy posixgroup Ns \&, Ns Sy smbgroup . .It Xo -.Nm +.Nm zfs .Cm projectspace .Op Fl Hp .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc diff --git a/man/man8/zfs-wait.8 b/man/man8/zfs-wait.8 index e7e3decb9da1..c3a85e29c6c0 100644 --- a/man/man8/zfs-wait.8 +++ b/man/man8/zfs-wait.8 @@ -31,17 +31,17 @@ .Dt ZFS-WAIT 8 .Os .Sh NAME -.Nm zfs Ns Pf - Cm wait +.Nm zfs-wait .Nd Wait for background activity to stop in a ZFS filesystem .Sh SYNOPSIS -.Nm +.Nm zfs .Cm wait .Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns ... .Ar fs .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zfs .Cm wait .Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns ... .Ar fs diff --git a/man/man8/zgenhostid.8 b/man/man8/zgenhostid.8 index ff198443dd2a..14264cb8cdc3 100644 --- a/man/man8/zgenhostid.8 +++ b/man/man8/zgenhostid.8 @@ -54,7 +54,8 @@ instead of default .It Ar hostid Specifies the value to be placed in .Pa /etc/hostid . -It must be a number with a value between 1 and 2^32-1. +It should be a number with a value between 1 and 2^32-1. +If it is 0, zgenhostid will generate a random hostid. This value .Sy must be unique among your systems. diff --git a/man/man8/zpool-add.8 b/man/man8/zpool-add.8 index e8adc353ac9c..cf1630435eb4 100644 --- a/man/man8/zpool-add.8 +++ b/man/man8/zpool-add.8 @@ -30,10 +30,10 @@ .Dt ZPOOL-ADD 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm add +.Nm zpool-add .Nd Adds specified virtual devices to a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm add .Op Fl fgLnP .Oo Fl o Ar property Ns = Ns Ar value Oc @@ -41,7 +41,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm add .Op Fl fgLnP .Oo Fl o Ar property Ns = Ns Ar value Oc diff --git a/man/man8/zpool-attach.8 b/man/man8/zpool-attach.8 index 03e04436df81..41b6a6b613da 100644 --- a/man/man8/zpool-attach.8 +++ b/man/man8/zpool-attach.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-ATTACH 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm attach +.Nm zpool-attach .Nd Attach a new device to an existing ZFS virtual device (vdev). .Sh SYNOPSIS -.Nm +.Nm zpool .Cm attach .Op Fl fsw .Oo Fl o Ar property Ns = Ns Ar value Oc @@ -42,7 +42,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm attach .Op Fl fsw .Oo Fl o Ar property Ns = Ns Ar value Oc diff --git a/man/man8/zpool-checkpoint.8 b/man/man8/zpool-checkpoint.8 index df04c8819146..128970ee66ac 100644 --- a/man/man8/zpool-checkpoint.8 +++ b/man/man8/zpool-checkpoint.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-CHECKPOINT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm checkpoint +.Nm zpool-checkpoint .Nd Checkpoints the current state of a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm checkpoint .Op Fl d, -discard Oo Fl w, -wait Oc .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm checkpoint .Op Fl d, -discard Oo Fl w, -wait Oc .Ar pool diff --git a/man/man8/zpool-clear.8 b/man/man8/zpool-clear.8 index ee7a6a255905..e00eb760af61 100644 --- a/man/man8/zpool-clear.8 +++ b/man/man8/zpool-clear.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-CLEAR 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm clear +.Nm zpool-clear .Nd Clears device errors in a ZFS storage pool. .Sh SYNOPSIS -.Nm +.Nm zpool .Cm clear .Ar pool .Op Ar device .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm clear .Ar pool .Op Ar device diff --git a/man/man8/zpool-create.8 b/man/man8/zpool-create.8 index 0676a67f9fc6..7406a493e377 100644 --- a/man/man8/zpool-create.8 +++ b/man/man8/zpool-create.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-CREATE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm create +.Nm zpool-create .Nd Creates a new ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm create .Op Fl dfn .Op Fl m Ar mountpoint @@ -46,7 +46,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm create .Op Fl dfn .Op Fl m Ar mountpoint @@ -73,12 +73,14 @@ and period The pool names .Sy mirror , .Sy raidz , +.Sy draid , .Sy spare and .Sy log are reserved, as are names beginning with .Sy mirror , .Sy raidz , +.Sy draid , .Sy spare , and the pattern .Sy c[0-9] . diff --git a/man/man8/zpool-destroy.8 b/man/man8/zpool-destroy.8 index 9eace1983ebb..d4fc21eaec02 100644 --- a/man/man8/zpool-destroy.8 +++ b/man/man8/zpool-destroy.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-DESTROY 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm destroy +.Nm zpool-destroy .Nd Destroys the given ZFS storage pool, freeing up any devices for other use .Sh SYNOPSIS -.Nm +.Nm zpool .Cm destroy .Op Fl f .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm destroy .Op Fl f .Ar pool diff --git a/man/man8/zpool-detach.8 b/man/man8/zpool-detach.8 index dab8871cea87..75a5786d5a3d 100644 --- a/man/man8/zpool-detach.8 +++ b/man/man8/zpool-detach.8 @@ -31,16 +31,16 @@ .Dt ZPOOL-DETACH 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm detach +.Nm zpool-detach .Nd Detaches a device from a ZFS mirror vdev (virtual device) .Sh SYNOPSIS -.Nm +.Nm zpool .Cm detach .Ar pool device .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm detach .Ar pool device .Xc diff --git a/man/man8/zpool-events.8 b/man/man8/zpool-events.8 index e5887a1d820d..3a6ff8840168 100644 --- a/man/man8/zpool-events.8 +++ b/man/man8/zpool-events.8 @@ -31,16 +31,16 @@ .Dt ZPOOL-EVENTS 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm events +.Nm zpool-events .Nd Lists all recent events generated by the ZFS kernel modules .Sh SYNOPSIS -.Nm +.Nm zpool .Cm events .Op Fl vHf Oo Ar pool Oc | Fl c .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm events .Op Fl vHf Oo Ar pool Oc | Fl c .Xc diff --git a/man/man8/zpool-export.8 b/man/man8/zpool-export.8 index afe185c98c58..1b8077ba19fa 100644 --- a/man/man8/zpool-export.8 +++ b/man/man8/zpool-export.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-EXPORT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm export +.Nm zpool-export .Nd Exports the given ZFS storage pools from the system .Sh SYNOPSIS -.Nm +.Nm zpool .Cm export .Op Fl a .Op Fl f @@ -42,7 +42,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm export .Op Fl a .Op Fl f @@ -60,7 +60,7 @@ A pool can not be exported if it has a shared spare that is currently being used. .Pp For pools to be portable, you must give the -.Nm +.Nm zpool command whole disks, not just partitions, so that ZFS can label the disks with portable EFI labels. Otherwise, disk drivers on platforms of different endianness will not recognize diff --git a/man/man8/zpool-get.8 b/man/man8/zpool-get.8 index fbe341a8cddd..c514bb0c5e8c 100644 --- a/man/man8/zpool-get.8 +++ b/man/man8/zpool-get.8 @@ -31,23 +31,23 @@ .Dt ZPOOL-GET 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm get +.Nm zpool-get .Nd Retrieves properties for the specified ZFS storage pool(s) .Sh SYNOPSIS -.Nm +.Nm zpool .Cm get .Op Fl Hp .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ... .Oo Ar pool Oc Ns ... -.Nm +.Nm zpool .Cm set .Ar property Ns = Ns Ar value .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm get .Op Fl Hp .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... @@ -85,7 +85,7 @@ is the default value. Display numbers in parsable (exact) values. .El .It Xo -.Nm +.Nm zpool .Cm set .Ar property Ns = Ns Ar value .Ar pool diff --git a/man/man8/zpool-history.8 b/man/man8/zpool-history.8 index 73fb27449d8c..5b0a102f3825 100644 --- a/man/man8/zpool-history.8 +++ b/man/man8/zpool-history.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-HISTORY 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm history +.Nm zpool-history .Nd Displays the command history of the specified ZFS storage pool(s) .Sh SYNOPSIS -.Nm +.Nm zpool .Cm history .Op Fl il .Oo Ar pool Oc Ns ... .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm history .Op Fl il .Oo Ar pool Oc Ns ... diff --git a/man/man8/zpool-import.8 b/man/man8/zpool-import.8 index e63db9363fd0..ac349574309e 100644 --- a/man/man8/zpool-import.8 +++ b/man/man8/zpool-import.8 @@ -31,14 +31,14 @@ .Dt ZPOOL-IMPORT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm import +.Nm zpool-import .Nd Lists ZFS storage pools available to import or import the specified pools .Sh SYNOPSIS -.Nm +.Nm zpool .Cm import .Op Fl D .Op Fl d Ar dir Ns | Ns device -.Nm +.Nm zpool .Cm import .Fl a .Op Fl DflmN @@ -48,7 +48,7 @@ .Op Fl o Ar mntopts .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... .Op Fl R Ar root -.Nm +.Nm zpool .Cm import .Op Fl Dflm .Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc @@ -63,7 +63,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm import .Op Fl D .Op Fl d Ar dir Ns | Ns device @@ -110,7 +110,7 @@ option can be specified multiple times. Lists destroyed pools only. .El .It Xo -.Nm +.Nm zpool .Cm import .Fl a .Op Fl DflmN @@ -244,7 +244,7 @@ option, above. WARNING: This option can be extremely hazardous to the health of your pool and should only be used as a last resort. .El .It Xo -.Nm +.Nm zpool .Cm import .Op Fl Dflm .Op Fl F Oo Fl n Oc Oo Fl t Oc Oo Fl T Oc Oo Fl X Oc diff --git a/man/man8/zpool-initialize.8 b/man/man8/zpool-initialize.8 index e8bf656e4b97..2734c1b340b8 100644 --- a/man/man8/zpool-initialize.8 +++ b/man/man8/zpool-initialize.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-INITIALIZE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm initialize +.Nm zpool-initialize .Nd Write to all unallocated regions of eligible devices in a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm initialize .Op Fl c | Fl s .Op Fl w @@ -43,7 +43,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm initialize .Op Fl c | Fl s .Op Fl w diff --git a/man/man8/zpool-iostat.8 b/man/man8/zpool-iostat.8 index f91e55c3b01a..e457eb142ab8 100644 --- a/man/man8/zpool-iostat.8 +++ b/man/man8/zpool-iostat.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-IOSTAT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm iostat +.Nm zpool-iostat .Nd Display logical I/O statistics for the given ZFS storage pools/vdevs .Sh SYNOPSIS -.Nm +.Nm zpool .Cm iostat .Op Oo Oo Fl c Ar SCRIPT Oc Oo Fl lq Oc Oc Ns | Ns Fl rw .Op Fl T Sy u Ns | Ns Sy d @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm iostat .Op Oo Oo Fl c Ar SCRIPT Oc Oo Fl lq Oc Oc Ns | Ns Fl rw .Op Fl T Sy u Ns | Ns Sy d diff --git a/man/man8/zpool-labelclear.8 b/man/man8/zpool-labelclear.8 index 52c80056142c..576eee21c508 100644 --- a/man/man8/zpool-labelclear.8 +++ b/man/man8/zpool-labelclear.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-LABELCLEAR 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm labelclear +.Nm zpool-labelclear .Nd Removes ZFS label information from the specified physical device .Sh SYNOPSIS -.Nm +.Nm zpool .Cm labelclear .Op Fl f .Ar device .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm labelclear .Op Fl f .Ar device diff --git a/man/man8/zpool-list.8 b/man/man8/zpool-list.8 index 5e8c6fe5c9ea..068a68893463 100644 --- a/man/man8/zpool-list.8 +++ b/man/man8/zpool-list.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-LIST 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm list +.Nm zpool-list .Nd Lists ZFS storage pools along with a health status and space usage .Sh SYNOPSIS -.Nm +.Nm zpool .Cm list .Op Fl HgLpPv .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm list .Op Fl HgLpPv .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... @@ -111,7 +111,7 @@ See .It Fl v Verbose statistics. Reports usage statistics for individual vdevs within the pool, in addition to -the pool-wise statistics. +the pool-wide statistics. .El .El .Sh SEE ALSO diff --git a/man/man8/zpool-offline.8 b/man/man8/zpool-offline.8 index cdcda141f5eb..3bf3bae72541 100644 --- a/man/man8/zpool-offline.8 +++ b/man/man8/zpool-offline.8 @@ -31,22 +31,22 @@ .Dt ZPOOL-OFFLINE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm offline +.Nm zpool-offline .Nd Take a physical device in a ZFS storage pool offline .Sh SYNOPSIS -.Nm +.Nm zpool .Cm offline .Op Fl f .Op Fl t .Ar pool Ar device Ns ... -.Nm +.Nm zpool .Cm online .Op Fl e .Ar pool Ar device Ns ... .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm offline .Op Fl f .Op Fl t @@ -68,7 +68,7 @@ Temporary. Upon reboot, the specified physical device reverts to its previous state. .El .It Xo -.Nm +.Nm zpool .Cm online .Op Fl e .Ar pool Ar device Ns ... diff --git a/man/man8/zpool-reguid.8 b/man/man8/zpool-reguid.8 index e73f421ade78..f5c4a33f694a 100644 --- a/man/man8/zpool-reguid.8 +++ b/man/man8/zpool-reguid.8 @@ -31,16 +31,16 @@ .Dt ZPOOL-REGUID 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm reguid +.Nm zpool-reguid .Nd Generate a new unique identifier for a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm reguid .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm reguid .Ar pool .Xc diff --git a/man/man8/zpool-remove.8 b/man/man8/zpool-remove.8 index cd394f107e8d..f491cd40ac5c 100644 --- a/man/man8/zpool-remove.8 +++ b/man/man8/zpool-remove.8 @@ -31,21 +31,21 @@ .Dt ZPOOL-REMOVE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm remove +.Nm zpool-remove .Nd Remove a device from a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm remove .Op Fl npw .Ar pool Ar device Ns ... -.Nm +.Nm zpool .Cm remove .Fl s .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm remove .Op Fl npw .Ar pool Ar device Ns ... @@ -95,7 +95,7 @@ flag, displays numbers as parsable (exact) values. Waits until the removal has completed before returning. .El .It Xo -.Nm +.Nm zpool .Cm remove .Fl s .Ar pool diff --git a/man/man8/zpool-reopen.8 b/man/man8/zpool-reopen.8 index 206fedcc57d9..6f804cc7e5f2 100644 --- a/man/man8/zpool-reopen.8 +++ b/man/man8/zpool-reopen.8 @@ -31,17 +31,17 @@ .Dt ZPOOL-REOPEN 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm reopen +.Nm zpool-reopen .Nd Reopen all virtual devices (vdevs) associated with a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm reopen .Op Fl n .Ar pool .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm reopen .Op Fl n .Ar pool diff --git a/man/man8/zpool-replace.8 b/man/man8/zpool-replace.8 index 32eaf77c0c2c..b8527a3862c5 100644 --- a/man/man8/zpool-replace.8 +++ b/man/man8/zpool-replace.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-REPLACE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm replace +.Nm zpool-replace .Nd Replace one device with another in a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm replace .Op Fl fsw .Oo Fl o Ar property Ns = Ns Ar value Oc @@ -42,7 +42,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm replace .Op Fl fsw .Op Fl o Ar property Ns = Ns Ar value diff --git a/man/man8/zpool-resilver.8 b/man/man8/zpool-resilver.8 index a804bea4a3b8..602e296fea11 100644 --- a/man/man8/zpool-resilver.8 +++ b/man/man8/zpool-resilver.8 @@ -31,16 +31,16 @@ .Dt ZPOOL-RESILVER 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm resilver +.Nm zpool-resilver .Nd Start a resilver of a device in a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm resilver .Ar pool Ns ... .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm resilver .Ar pool Ns ... .Xc diff --git a/man/man8/zpool-scrub.8 b/man/man8/zpool-scrub.8 index a5624795544c..6ff2eb261017 100644 --- a/man/man8/zpool-scrub.8 +++ b/man/man8/zpool-scrub.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-SCRUB 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm scrub +.Nm zpool-scrub .Nd Begin a scrub or resume a paused scrub of a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm scrub .Op Fl s | Fl p .Op Fl w @@ -42,7 +42,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm scrub .Op Fl s | Fl p .Op Fl w @@ -52,7 +52,7 @@ Begins a scrub or resumes a paused scrub. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated -.Pq mirror or raidz +.Pq mirror, raidz, or draid devices, ZFS automatically repairs any damage discovered during the scrub. The .Nm zpool Cm status diff --git a/man/man8/zpool-split.8 b/man/man8/zpool-split.8 index d2943e6e374b..609cbe6bad29 100644 --- a/man/man8/zpool-split.8 +++ b/man/man8/zpool-split.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-SPLIT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm split +.Nm zpool-split .Nd Split devices off a ZFS storage pool creating a new pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm split .Op Fl gLlnP .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm split .Op Fl gLlnP .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... diff --git a/man/man8/zpool-status.8 b/man/man8/zpool-status.8 index c2fe76c03812..54f0987b80c6 100644 --- a/man/man8/zpool-status.8 +++ b/man/man8/zpool-status.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-STATUS 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm status +.Nm zpool-status .Nd Display detailed health status for the given ZFS storage pools .Sh SYNOPSIS -.Nm +.Nm zpool .Cm status .Oo Fl c Ar SCRIPT Oc .Op Fl DigLpPstvx @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm status .Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ... .Op Fl DigLpPstvx diff --git a/man/man8/zpool-sync.8 b/man/man8/zpool-sync.8 index 098fdde9e5c9..027d129d181c 100644 --- a/man/man8/zpool-sync.8 +++ b/man/man8/zpool-sync.8 @@ -31,16 +31,16 @@ .Dt ZPOOL-SYNC 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm sync +.Nm zpool-sync .Nd Force data to be written to primary storage of a ZFS storage pool and update reporting data .Sh SYNOPSIS -.Nm +.Nm zpool .Cm sync .Oo Ar pool Oc Ns ... .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm sync .Op Ar pool ... .Xc diff --git a/man/man8/zpool-trim.8 b/man/man8/zpool-trim.8 index eef58aae5da6..1d8bc6e44a24 100644 --- a/man/man8/zpool-trim.8 +++ b/man/man8/zpool-trim.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-TRIM 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm trim +.Nm zpool-trim .Nd Initiate immediate TRIM operations for all free space in a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm trim .Op Fl dw .Op Fl r Ar rate @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm trim .Op Fl dw .Op Fl c | Fl s diff --git a/man/man8/zpool-upgrade.8 b/man/man8/zpool-upgrade.8 index d23d0e0e6d0c..b9d023b22d3f 100644 --- a/man/man8/zpool-upgrade.8 +++ b/man/man8/zpool-upgrade.8 @@ -31,22 +31,22 @@ .Dt ZPOOL-UPGRADE 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm upgrade +.Nm zpool-upgrade .Nd Manage version and feature flags of ZFS storage pools .Sh SYNOPSIS -.Nm +.Nm zpool .Cm upgrade -.Nm +.Nm zpool .Cm upgrade .Fl v -.Nm +.Nm zpool .Cm upgrade .Op Fl V Ar version .Fl a Ns | Ns Ar pool Ns ... .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm upgrade .Xc Displays pools which do not have all supported features enabled and pools @@ -56,7 +56,7 @@ Use .Nm zpool Cm upgrade Fl a to enable all features on all pools. .It Xo -.Nm +.Nm zpool .Cm upgrade .Fl v .Xc @@ -65,7 +65,7 @@ See .Xr zpool-features 5 for a description of feature flags features supported by the current software. .It Xo -.Nm +.Nm zpool .Cm upgrade .Op Fl V Ar version .Fl a Ns | Ns Ar pool Ns ... diff --git a/man/man8/zpool-wait.8 b/man/man8/zpool-wait.8 index a3bdba669e53..ff6d992243b8 100644 --- a/man/man8/zpool-wait.8 +++ b/man/man8/zpool-wait.8 @@ -31,10 +31,10 @@ .Dt ZPOOL-WAIT 8 .Os .Sh NAME -.Nm zpool Ns Pf - Cm wait +.Nm zpool-wait .Nd Wait for background activity to stop in a ZFS storage pool .Sh SYNOPSIS -.Nm +.Nm zpool .Cm wait .Op Fl Hp .Op Fl T Sy u Ns | Ns Sy d @@ -44,7 +44,7 @@ .Sh DESCRIPTION .Bl -tag -width Ds .It Xo -.Nm +.Nm zpool .Cm wait .Op Fl Hp .Op Fl T Sy u Ns | Ns Sy d diff --git a/man/man8/zpool_influxdb.8 b/man/man8/zpool_influxdb.8 new file mode 100644 index 000000000000..bd899dbe90a0 --- /dev/null +++ b/man/man8/zpool_influxdb.8 @@ -0,0 +1,93 @@ +.\" +.\" CDDL HEADER START +.\" +.\" The contents of this file are subject to the terms of the +.\" Common Development and Distribution License (the "License"). +.\" You may not use this file except in compliance with the License. +.\" +.\" You can obtain a copy of the license at +.\" https://opensource.org/licenses/CDDL-1.0 +.\" 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] +.\" +.\" CDDL HEADER END +.\" +.\" +.\" Copyright 2020 Richard Elling +.\" .Dd June 14, 2020 +.TH zpool_influxdb 8 +.SH NAME +zpool_influxdb \- collect zpool statistics in influxdb line protocol format +.SH SYNOPSIS +.LP +.nf +\fBzpool_influxdb\fR [--execd] [--no-histogram] [--sum-histogram-buckets] +[--tags key=value] [pool] +\fBzpool_influxdb\fR --help +.fi +.SH DESCRIPTION +The \fBzpool_influxdb\fR command produces influxdb line protocol compatible +metrics from zpools. Like the \fBzpool\fR command, \fBzpool_influxdb\fR +reads the current pool status and statistics. Unlike the \fBzpool\fR +command which is intended for humans, \fBzpool_influxdb\fR formats the +output in influxdb line protocol. The expected use is as a plugin to a +metrics collector or aggregator, such as telegraf. + +By default, \fBzpool_influxdb\fR prints pool metrics and status in the +influxdb line protocol format. All pools are printed, similar to +the \fBzpool status\fR command. Providing a pool name restricts the +output to the named pool. + +Like the \fBzpool\fR command, \fBzpool_influxdb\fR uses internal data +structures that can change over time as new ZFS releases are made. +Therefore, the \fBzpool_influxdb\fR command must be compiled against the +ZFS source. It is expected that later releases of ZFS includes compatible +\fBzpool_influxdb\fR and \fBzpool\fR commands. + +.SH OPTIONS +.TP +\fB\--execd\fR, \fB-e\fR +Run in daemon mode compatible with telegraf`s \fBexecd\fR plugin. +In this mode, the pools are sampled every time there is a [return] on stdin. +Once a sample printed, \fBzpool_influxdb\fR waits for another [return]. +When run on a terminal, use [ctrl+C] to exit. +.TP +\fB\--no-histogram\fR, \fB-n\fR +Do not print latency and I/O size histograms. This can reduce the total +amount of data, but one should consider the value brought by the insights +that latency and I/O size distributions provide. The resulting values +are suitable for graphing with grafana's heatmap plugin. +.TP +\fB--sum-histogram-buckets\fR, \fB-s\fR +Accumulates bucket values. By default, the values are not accumulated and +the raw data appears as shown by \fBzpool iostat\fR. This works well for +grafana's heatmap plugin. Summing the buckets produces output similar to +prometheus histograms. +.TP +\fB--tags\fR, \fB-t\fR +Adds specified tags to the tag set. Tags are key=value pairs and multiple +tags are separated by commas. No sanity checking is performed. +See the InfluxDB Line Protocol format documentation for details on escaping +special characters used in tags. +.TP +\fB\--help\fR, \fB\-h\fR +Print a usage summary. + +.SH SEE ALSO +.LP +\fBzpool-status\fR(8) +\fBzpool-iostat\fR(8) +.PP +Influxdb https://github.com/influxdata/influxdb +.PP +Telegraf https://github.com/influxdata/telegraf +.PP +Grafana https://grafana.com +.PP +Prometheus https://prometheus.io diff --git a/man/man8/zpoolconcepts.8 b/man/man8/zpoolconcepts.8 index f9c262f4be42..d999b03547a9 100644 --- a/man/man8/zpoolconcepts.8 +++ b/man/man8/zpoolconcepts.8 @@ -64,7 +64,7 @@ A file must be specified by a full path. A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with N disks of size X can hold X bytes and can withstand (N-1) devices -failing before data integrity is compromised. +failing without losing data. .It Sy raidz , raidz1 , raidz2 , raidz3 A variation on RAID-5 that allows for better distribution of parity and eliminates the RAID-5 @@ -88,11 +88,75 @@ vdev type is an alias for .Sy raidz1 . .Pp A raidz group with N disks of size X with P parity disks can hold approximately -(N-P)*X bytes and can withstand P device(s) failing before data integrity is -compromised. +(N-P)*X bytes and can withstand P device(s) failing without losing data. The minimum number of devices in a raidz group is one more than the number of parity disks. The recommended number is between 3 and 9 to help increase performance. +.It Sy draid , draid1 , draid2 , draid3 +A variant of raidz that provides integrated distributed hot spares which +allows for faster resilvering while retaining the benefits of raidz. +A dRAID vdev is constructed from multiple internal raidz groups, each with D +data devices and P parity devices. +These groups are distributed over all of the children in order to fully +utilize the available disk performance. +.Pp +Unlike raidz, dRAID uses a fixed stripe width (padding as necessary with +zeros) to allow fully sequential resilvering. +This fixed stripe width significantly effects both usable capacity and IOPS. +For example, with the default D=8 and 4k disk sectors the minimum allocation +size is 32k. +If using compression, this relatively large allocation size can reduce the +effective compression ratio. +When using ZFS volumes and dRAID the default volblocksize property is increased +to account for the allocation size. +If a dRAID pool will hold a significant amount of small blocks, it is +recommended to also add a mirrored +.Sy special +vdev to store those blocks. +.Pp +In regards to IO/s, performance is similar to raidz since for any read all D +data disks must be accessed. +Delivered random IOPS can be reasonably approximated as +floor((N-S)/(D+P))*<single-drive-IOPS>. +.Pp +Like raidz a dRAID can have single-, double-, or triple-parity. The +.Sy draid1 , +.Sy draid2 , +and +.Sy draid3 +types can be used to specify the parity level. +The +.Sy draid +vdev type is an alias for +.Sy draid1 . +.Pp +A dRAID with N disks of size X, D data disks per redundancy group, P parity +level, and S distributed hot spares can hold approximately (N-S)*(D/(D+P))*X +bytes and can withstand P device(s) failing without losing data. +.It Sy draid[<parity>][:<data>d][:<children>c][:<spares>s] +A non-default dRAID configuration can be specified by appending one or more +of the following optional arguments to the +.Sy draid +keyword. +.Pp +.Em parity +- The parity level (1-3). +.Pp +.Em data +- The number of data devices per redundancy group. +In general a smaller value of D will increase IOPS, improve the compression ratio, and speed up resilvering at the expense of total usable capacity. +Defaults to 8, unless N-P-S is less than 8. +.Pp +.Em children +- The expected number of children. +Useful as a cross-check when listing a large number of devices. +An error is returned when the provided number of children differs. +.Pp +.Em spares +- The number of distributed hot spares. +Defaults to zero. +.Pp +.Pp .It Sy spare A pseudo-vdev which keeps track of available hot spares for a pool. For more information, see the @@ -273,6 +337,14 @@ If the original faulted device is detached, then the hot spare assumes its place in the configuration, and is removed from the spare list of all active pools. .Pp +The +.Sy draid +vdev type provides distributed hot spares. +These hot spares are named after the dRAID vdev they're a part of ( +.Qq draid1-2-3 specifies spare 3 of vdev 2, which is a single parity dRAID +) and may only be used by that dRAID vdev. +Otherwise, they behave the same as normal hot spares. +.Pp Spares cannot replace log devices. .Ss Intent Log The ZFS Intent Log (ZIL) satisfies POSIX requirements for synchronous diff --git a/man/man8/zpoolprops.8 b/man/man8/zpoolprops.8 index 3437e48864ce..f78acaa46505 100644 --- a/man/man8/zpoolprops.8 +++ b/man/man8/zpoolprops.8 @@ -54,12 +54,15 @@ This property can also be referred to by its shortened column name, .It Sy expandsize 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 -.Po e.g, using -.Nm zpool Cm online Fl e -.Pc . -This space occurs when a LUN is dynamically expanded. +On whole-disk vdevs, this is the space beyond the end of the GPT – +typically occurring when a LUN is dynamically expanded +or a disk replaced with a larger one. +On partition vdevs, this is the space appended to the partition after it was +added to the pool – most likely by resizing it in-place. +The space can be claimed for the pool by bringing it online with +.Sy autoexpand=on +or using +.Nm zpool Cm online Fl e . .It Sy fragmentation The amount of fragmentation in the pool. As the amount of space .Sy allocated |