zpool-*.8: Add appropriate SEE ALSO sections

Divided zpool subcommand manual pages need their own SEE ALSO sections. Also modified fsck.zfs.8 to point directly to zfs-scrub.8 and zed.8.in to include a direct reference to zfs-events.8
openzfs · Nov 11, 2019 · 4e81984 · 4e81984
1 parent 0596490
commit 4e81984
Show file tree

Hide file tree

Showing 30 changed files with 141 additions and 1 deletion.
diff --git a/man/man8/fsck.zfs.8 b/man/man8/fsck.zfs.8
@@ -64,4 +64,4 @@ Darik Horn <dajhorn@vanadac.com>.
 .SH "SEE ALSO"
 .BR fsck (8),
 .BR fstab (5),
-.BR zpool (8)
+.BR zpool-scrub (8)
diff --git a/man/man8/zed.8.in b/man/man8/zed.8.in
@@ -258,3 +258,4 @@ Developed at Lawrence Livermore National Laboratory (LLNL\-CODE\-403049).
 .SH SEE ALSO
 .BR zfs (8),
 .BR zpool (8)
+.BR zpool-events (8)
diff --git a/man/man8/zpool-add.8 b/man/man8/zpool-add.8
@@ -94,3 +94,9 @@ manual page for a list of valid properties that can be set. The only property
 supported at the moment is ashift.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-remove 8 ,
+.Xr zpool-attach 8 ,
+.Xr zpool-import 8 ,
+.Xr zpool-initialize 8 ,
+.Xr zpool-online 8
diff --git a/man/man8/zpool-attach.8 b/man/man8/zpool-attach.8
@@ -86,3 +86,11 @@ manual page for a list of valid properties that can be set. The only property
 supported at the moment is ashift.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-detach 8 ,
+.Xr zpool-add 8 ,
+.Xr zpool-import 8 ,
+.Xr zpool-initialize 8 ,
+.Xr zpool-online 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-resilver 8
diff --git a/man/man8/zpool-checkpoint.8 b/man/man8/zpool-checkpoint.8
@@ -76,3 +76,7 @@ Discards an existing checkpoint from
 Waits until the checkpoint has finished being discarded before returning.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-import 8 ,
+.Xr zpool-status 8 ,
+.Xr zfs-snapshot 8
diff --git a/man/man8/zpool-clear.8 b/man/man8/zpool-clear.8
@@ -54,3 +54,7 @@ If multihost is enabled, and the pool has been suspended, this will not
 resume I/O.  While the pool was suspended, it may have been imported on
 another host, and resuming I/O could result in pool damage.
 .El
+.Sh SEE ALSO
+.Xr zdb 8 ,
+.Xr zpool-reopen 8 ,
+.Xr zpool-status 8
diff --git a/man/man8/zpool-create.8 b/man/man8/zpool-create.8
@@ -201,3 +201,7 @@ such as virtual machines or physical machines whose pools live on network
 block devices.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-destroy 8 ,
+.Xr zpool-export 8 ,
+.Xr zpool-import 8
diff --git a/man/man8/zpool-detach.8 b/man/man8/zpool-detach.8
@@ -52,3 +52,10 @@ If device may be re-added to the pool later on then consider the
 .Sy zpool offline
 command instead.
 .El
+.Sh SEE ALSO
+.Xr zpool-attach 8 ,
+.Xr zpool-offline 8 ,
+.Xr zpool-labelclear 8 ,
+.Xr zpool-remove 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-split 8
diff --git a/man/man8/zpool-events.8 b/man/man8/zpool-events.8
@@ -64,3 +64,8 @@ single tab instead of arbitrary space.
 Print the entire payload for each event.
 .El
 .El
+.Sh SEE ALSO
+.Xr zed 8 ,
+.Xr zpool-wait 8 ,
+.Xr zfs-events 5 ,
+.Xr zfs-module-parameters 5
diff --git a/man/man8/zpool-export.8 b/man/man8/zpool-export.8
@@ -78,3 +78,5 @@ is currently being used.
 This may lead to potential data corruption.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-import 8
diff --git a/man/man8/zpool-get.8 b/man/man8/zpool-get.8
@@ -96,3 +96,7 @@ See the
 manual page for more information on what properties can be set and acceptable
 values.
 .El
+.Sh SEE ALSO
+.Xr zpoolprops 8 ,
+.Xr zpool-list 8 ,
+.Xr zpool-features 5
diff --git a/man/man8/zpool-history.8 b/man/man8/zpool-history.8
@@ -57,3 +57,8 @@ includes, the user name, the hostname, and the zone in which the operation was
 performed.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-checkpoint 8 ,
+.Xr zpool-events 8 ,
+.Xr zpool-status 8 ,
+.Xr zpool-wait 8
diff --git a/man/man8/zpool-import.8 b/man/man8/zpool-import.8
@@ -381,3 +381,7 @@ is retained upon export.
 Will also set -o cachefile=none when not explicitly specified.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-export 8 ,
+.Xr zpool-list 8 ,
+.Xr zpool-status 8
diff --git a/man/man8/zpool-initialize.8 b/man/man8/zpool-initialize.8
@@ -72,3 +72,10 @@ with no flags on the relevant target devices.
 Wait until the devices have finished initializing before returning.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-add 8 ,
+.Xr zpool-attach 8 ,
+.Xr zpool-create 8 ,
+.Xr zpool-online 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-trim 8
diff --git a/man/man8/zpool-iostat.8 b/man/man8/zpool-iostat.8
@@ -240,3 +240,8 @@ entries in the queues. If you specify an interval, the measurements
 will be sampled from the end of the interval.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-list 8 ,
+.Xr zpool-status 8 ,
+.Xr iostat 1 ,
+.Xr smartctl 8
diff --git a/man/man8/zpool-labelclear.8 b/man/man8/zpool-labelclear.8
@@ -56,3 +56,8 @@ must not be part of an active pool configuration.
 Treat exported or foreign devices as inactive.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-destroy 8 ,
+.Xr zpool-detach 8 ,
+.Xr zpool-remove 8 ,
+.Xr zpool-replace 8
diff --git a/man/man8/zpool-list.8 b/man/man8/zpool-list.8
@@ -114,3 +114,6 @@ Reports usage statistics for individual vdevs within the pool, in addition to
 the pool-wise statistics.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-import 8 ,
+.Xr zpool-status 8
diff --git a/man/man8/zpool-offline.8 b/man/man8/zpool-offline.8
@@ -82,3 +82,8 @@ If the device is part of a mirror or raidz then all devices must be expanded
 before the new space will become available to the pool.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-detach 8 ,
+.Xr zpool-remove 8 ,
+.Xr zpool-reopen 8 ,
+.Xr zpool-resilver 8
diff --git a/man/man8/zpool-reguid.8 b/man/man8/zpool-reguid.8
@@ -48,3 +48,6 @@ Generates a new unique identifier for the pool.
 You must ensure that all devices in this pool are online and healthy before
 performing this action.
 .El
+.Sh SEE ALSO
+.Xr zpool-export 8 ,
+.Xr zpool-import 8
diff --git a/man/man8/zpool-remove.8 b/man/man8/zpool-remove.8
@@ -100,3 +100,10 @@ Waits until the removal has completed before returning.
 .Xc
 Stops and cancels an in-progress removal of a top-level vdev.
 .El
+.Sh SEE ALSO
+.Xr zpool-add 8 ,
+.Xr zpool-detach 8 ,
+.Xr zpool-offline 8 ,
+.Xr zpool-labelclear 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-split 8
diff --git a/man/man8/zpool-replace.8 b/man/man8/zpool-replace.8
@@ -90,3 +90,8 @@ The only property supported at the moment is
 Waits until the replacement has completed before returning.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-detach 8 ,
+.Xr zpool-initialize 8 ,
+.Xr zpool-online 8 ,
+.Xr zpool-resilver 8
diff --git a/man/man8/zpool-resilver.8 b/man/man8/zpool-resilver.8
@@ -50,3 +50,10 @@ resilver will be added to the new one. This requires the
 .Sy resilver_defer
 feature.
 .El
+.Sh SEE ALSO
+.Xr zpool-iostat 8 ,
+.Xr zpool-online 8 ,
+.Xr zpool-reopen 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-scrub 8 ,
+.Xr zpool-status 8
diff --git a/man/man8/zpool-scrub.8 b/man/man8/zpool-scrub.8
@@ -99,3 +99,7 @@ again.
 Wait until scrub has completed before returning.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-iostat 8 ,
+.Xr zpool-resilver 8 ,
+.Xr zpool-status 8
diff --git a/man/man8/zpool-split.8 b/man/man8/zpool-split.8
@@ -118,3 +118,7 @@ to
 and automatically import it.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-import 8 ,
+.Xr zpool-list 8 ,
+.Xr zpool-remove 8
diff --git a/man/man8/zpool-status.8 b/man/man8/zpool-status.8
@@ -128,3 +128,11 @@ unavailable.
 Warnings about pools not using the latest on-disk format will not be included.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-events 8 ,
+.Xr zpool-history 8 ,
+.Xr zpool-iostat 8 ,
+.Xr zpool-list 8 ,
+.Xr zpool-resilver 8 ,
+.Xr zpool-scrub 8 ,
+.Xr zpool-wait 8
diff --git a/man/man8/zpool-sync.8 b/man/man8/zpool-sync.8
@@ -51,3 +51,7 @@ information including quota reporting. Without arguments,
 will sync all pools on the system. Otherwise, it will sync only the
 specified pool(s).
 .El
+.Sh SEE ALSO
+.Xr zpoolconcepts 8 ,
+.Xr zpool-export 8 ,
+.Xr zpool-iostat 8
diff --git a/man/man8/zpool-trim.8 b/man/man8/zpool-trim.8
@@ -86,3 +86,7 @@ Trimming can then be resumed by running
 with no flags on the relevant target devices.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-initialize 8 ,
+.Xr zpool-wait 8 ,
+.Xr zpoolprops 8
diff --git a/man/man8/zpool-upgrade.8 b/man/man8/zpool-upgrade.8
@@ -89,3 +89,8 @@ This option can only be used to increase the version number up to the last
 supported legacy version number.
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-features 5 ,
+.Xr zpoolconcepts 8 ,
+.Xr zpoolprops 8 ,
+.Xr zpool-history 8
diff --git a/man/man8/zpool-wait.8 b/man/man8/zpool-wait.8
@@ -102,3 +102,11 @@ See
 .Xr date 1 .
 .El
 .El
+.Sh SEE ALSO
+.Xr zpool-status 8 ,
+.Xr zpool-checkpoint 8 ,
+.Xr zpool-initialize 8 ,
+.Xr zpool-replace 8 ,
+.Xr zpool-remove 8 ,
+.Xr zpool-resilver 8 ,
+.Xr zpool-scrub 8
diff --git a/man/man8/zpool.8 b/man/man8/zpool.8
@@ -563,6 +563,8 @@ is not set, it is assumed that the user is allowed to run
 .Sh INTERFACE STABILITY
 .Sy Evolving
 .Sh SEE ALSO
+.Xr zpoolconcepts 8 ,
+.Xr zpoolprops 8 ,
 .Xr zfs-events 5 ,
 .Xr zfs-module-parameters 5 ,
 .Xr zpool-features 5 ,