diff options
author | Ryan Moeller <[email protected]> | 2020-08-25 00:25:28 -0400 |
---|---|---|
committer | GitHub <[email protected]> | 2020-08-24 21:25:28 -0700 |
commit | b596585fd9eefffb0a476c92c731db2c49d29938 (patch) | |
tree | 947f6eb07b0cb942a52400d63e793074eec09e3e | |
parent | b9007997682fac4a4272f2d59fc3df4875db2df0 (diff) |
man: Canonicalize .TH usage
* Use all caps for document title.
* Remove section name as it can be inferred from the section number.
* Name "OpenZFS" as the document source.
* Bump modification date.
While here, fixed trailing whitespace reported by igor.
Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: George Melikov <[email protected]>
Signed-off-by: Ryan Moeller <[email protected]>
Closes #10792
-rw-r--r-- | man/man1/arcstat.1 | 2 | ||||
-rw-r--r-- | man/man1/cstyle.1 | 2 | ||||
-rw-r--r-- | man/man1/raidz_test.1 | 2 | ||||
-rw-r--r-- | man/man1/zhack.1 | 2 | ||||
-rw-r--r-- | man/man1/ztest.1 | 2 | ||||
-rw-r--r-- | man/man5/spl-module-parameters.5 | 4 | ||||
-rw-r--r-- | man/man5/vdev_id.conf.5 | 2 | ||||
-rw-r--r-- | man/man5/zfs-events.5 | 2 | ||||
-rw-r--r-- | man/man5/zfs-module-parameters.5 | 6 | ||||
-rw-r--r-- | man/man5/zpool-features.5 | 2 | ||||
-rw-r--r-- | man/man8/fsck.zfs.8 | 2 | ||||
-rw-r--r-- | man/man8/mount.zfs.8 | 2 | ||||
-rw-r--r-- | man/man8/vdev_id.8 | 2 | ||||
-rw-r--r-- | man/man8/zed.8.in | 2 | ||||
-rw-r--r-- | man/man8/zfs-mount-generator.8.in | 2 | ||||
-rw-r--r-- | man/man8/zinject.8 | 2 | ||||
-rw-r--r-- | man/man8/zpool-iostat.8 | 4 | ||||
-rw-r--r-- | man/man8/zstreamdump.8 | 2 |
18 files changed, 22 insertions, 22 deletions
diff --git a/man/man1/arcstat.1 b/man/man1/arcstat.1 index 9113b76af..7fe1e0bfb 100644 --- a/man/man1/arcstat.1 +++ b/man/man1/arcstat.1 @@ -13,7 +13,7 @@ .\" Copyright (c) 2015 by Delphix. All rights reserved. .\" Copyright (c) 2020 by AJ Jordan. All rights reserved. .\" -.TH ARCSTAT 1 "May 7, 2020" +.TH ARCSTAT 1 "Aug 24, 2020" OpenZFS .SH NAME arcstat \- report ZFS ARC and L2ARC statistics .SH SYNOPSIS diff --git a/man/man1/cstyle.1 b/man/man1/cstyle.1 index f77d53450..14175838a 100644 --- a/man/man1/cstyle.1 +++ b/man/man1/cstyle.1 @@ -20,7 +20,7 @@ .\" .\" CDDL HEADER END .\" -.TH cstyle 1 "28 March 2005" +.TH CSTYLE 1 "Aug 24, 2020" OpenZFS .SH NAME .I cstyle \- check for some common stylistic errors in C source files diff --git a/man/man1/raidz_test.1 b/man/man1/raidz_test.1 index 423177a1b..63e9144ad 100644 --- a/man/man1/raidz_test.1 +++ b/man/man1/raidz_test.1 @@ -22,7 +22,7 @@ .\" .\" Copyright (c) 2016 Gvozden Nešković. All rights reserved. .\" -.TH raidz_test 1 "2016" "ZFS on Linux" "User Commands" +.TH RAIDZ_TEST 1 "Aug 24, 2020" OpenZFS .SH NAME \fBraidz_test\fR \- raidz implementation verification and benchmarking tool diff --git a/man/man1/zhack.1 b/man/man1/zhack.1 index 11d300b70..3126007a5 100644 --- a/man/man1/zhack.1 +++ b/man/man1/zhack.1 @@ -22,7 +22,7 @@ .\" .\" Copyright 2013 Darik Horn <[email protected]>. All rights reserved. .\" -.TH zhack 1 "2013 MAR 16" "ZFS on Linux" "User Commands" +.TH ZHACK 1 "Aug 24, 2020" OpenZFS .SH NAME zhack \- libzpool debugging tool diff --git a/man/man1/ztest.1 b/man/man1/ztest.1 index 84e56c822..68c978ca0 100644 --- a/man/man1/ztest.1 +++ b/man/man1/ztest.1 @@ -24,7 +24,7 @@ .\" Copyright (c) 2009 Michael Gebetsroither <[email protected]>. All rights .\" reserved. .\" -.TH ztest 1 "2009 NOV 01" "ZFS on Linux" "User Commands" +.TH ZTEST 1 "Aug 24, 2020" OpenZFS .SH NAME \fBztest\fR \- was written by the ZFS Developers as a ZFS unit test. diff --git a/man/man5/spl-module-parameters.5 b/man/man5/spl-module-parameters.5 index 2dce5b296..5e28e694e 100644 --- a/man/man5/spl-module-parameters.5 +++ b/man/man5/spl-module-parameters.5 @@ -2,7 +2,7 @@ .\" .\" Copyright 2013 Turbo Fredriksson <[email protected]>. All rights reserved. .\" -.TH SPL-MODULE-PARAMETERS 5 "Oct 28, 2017" +.TH SPL-MODULE-PARAMETERS 5 "Aug 24, 2020" OpenZFS .SH NAME spl\-module\-parameters \- SPL module parameters .SH DESCRIPTION @@ -225,7 +225,7 @@ Default value: \fB/etc/hostid\fR \fBspl_panic_halt\fR (uint) .ad .RS 12n -Cause a kernel panic on assertion failures. When not enabled, the thread is +Cause a kernel panic on assertion failures. When not enabled, the thread is halted to facilitate further debugging. .sp Set to a non-zero value to enable. diff --git a/man/man5/vdev_id.conf.5 b/man/man5/vdev_id.conf.5 index 89c5ee961..9ae3865f7 100644 --- a/man/man5/vdev_id.conf.5 +++ b/man/man5/vdev_id.conf.5 @@ -1,4 +1,4 @@ -.TH vdev_id.conf 5 +.TH VDEV_ID.CONF 5 "Aug 24, 2020" OpenZFS .SH NAME vdev_id.conf \- Configuration file for vdev_id .SH DESCRIPTION diff --git a/man/man5/zfs-events.5 b/man/man5/zfs-events.5 index 4a28be71e..0d0e1a959 100644 --- a/man/man5/zfs-events.5 +++ b/man/man5/zfs-events.5 @@ -13,7 +13,7 @@ .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your .\" own identifying information: .\" Portions Copyright [yyyy] [name of copyright owner] -.TH ZFS-EVENTS 5 "Oct 24, 2018" +.TH ZFS-EVENTS 5 "Aug 24, 2020" OpenZFS .SH NAME zfs\-events \- Events created by the ZFS filesystem. .SH DESCRIPTION diff --git a/man/man5/zfs-module-parameters.5 b/man/man5/zfs-module-parameters.5 index 853e8fc94..444e74748 100644 --- a/man/man5/zfs-module-parameters.5 +++ b/man/man5/zfs-module-parameters.5 @@ -14,7 +14,7 @@ .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your .\" own identifying information: .\" Portions Copyright [yyyy] [name of copyright owner] -.TH ZFS-MODULE-PARAMETERS 5 "Feb 15, 2019" +.TH ZFS-MODULE-PARAMETERS 5 "Aug 24, 2020" OpenZFS .SH NAME zfs\-module\-parameters \- ZFS module parameters .SH DESCRIPTION @@ -426,7 +426,7 @@ Default value: \fB16,777,216\fR (16MB) .RS 12n If we are not searching forward (due to metaslab_df_max_search, metaslab_df_free_pct, or metaslab_df_alloc_threshold), this tunable controls -what segment is used. If it is set, we will use the largest free segment. +what segment is used. If it is set, we will use the largest free segment. If it is not set, we will use a segment of exactly the requested size (or larger). .sp @@ -3256,7 +3256,7 @@ Default value: \fB25\fR. \fBzfs_sync_pass_dont_compress\fR (int) .ad .RS 12n -Starting in this sync pass, we disable compression (including of metadata). +Starting in this sync pass, we disable compression (including of metadata). With the default setting, in practice, we don't have this many sync passes, so this has no effect. .sp diff --git a/man/man5/zpool-features.5 b/man/man5/zpool-features.5 index f65ef40a7..36c4343a1 100644 --- a/man/man5/zpool-features.5 +++ b/man/man5/zpool-features.5 @@ -16,7 +16,7 @@ .\" Portions Copyright [yyyy] [name of copyright owner] .\" Copyright (c) 2019, Klara Inc. .\" Copyright (c) 2019, Allan Jude -.TH ZPOOL-FEATURES 5 "Jun 8, 2018" +.TH ZPOOL-FEATURES 5 "Aug 24, 2020" OpenZFS .SH NAME zpool\-features \- ZFS pool feature descriptions .SH DESCRIPTION diff --git a/man/man8/fsck.zfs.8 b/man/man8/fsck.zfs.8 index 80e7a1ebb..f681c2502 100644 --- a/man/man8/fsck.zfs.8 +++ b/man/man8/fsck.zfs.8 @@ -22,7 +22,7 @@ .\" .\" Copyright 2013 Darik Horn <[email protected]>. All rights reserved. .\" -.TH fsck.zfs 8 "2013 MAR 16" "ZFS on Linux" "System Administration Commands" +.TH FSCK.ZFS 8 "Aug 24, 2020" OpenZFS .SH NAME fsck.zfs \- Dummy ZFS filesystem checker. diff --git a/man/man8/mount.zfs.8 b/man/man8/mount.zfs.8 index 4b71367e2..016a909c2 100644 --- a/man/man8/mount.zfs.8 +++ b/man/man8/mount.zfs.8 @@ -22,7 +22,7 @@ .\" .\" Copyright 2013 Darik Horn <[email protected]>. All rights reserved. .\" -.TH mount.zfs 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands" +.TH MOUNT.ZFS 8 "Aug 24, 2020" OpenZFS .SH NAME mount.zfs \- mount a ZFS filesystem diff --git a/man/man8/vdev_id.8 b/man/man8/vdev_id.8 index 70956c634..6de3d18fe 100644 --- a/man/man8/vdev_id.8 +++ b/man/man8/vdev_id.8 @@ -1,4 +1,4 @@ -.TH vdev_id 8 +.TH VDEV_ID 8 "Aug 24, 2020" OpenZFS .SH NAME vdev_id \- generate user-friendly names for JBOD disks .SH SYNOPSIS diff --git a/man/man8/zed.8.in b/man/man8/zed.8.in index 2ca393572..9d494d5e8 100644 --- a/man/man8/zed.8.in +++ b/man/man8/zed.8.in @@ -11,7 +11,7 @@ .\" "OPENSOLARIS.LICENSE" or at <http://opensource.org/licenses/CDDL-1.0>. .\" You may not use this file except in compliance with the license. .\" -.TH ZED 8 "Octember 1, 2013" "ZFS on Linux" "System Administration Commands" +.TH ZED 8 "Aug 24, 2020" OpenZFS .SH NAME ZED \- ZFS Event Daemon diff --git a/man/man8/zfs-mount-generator.8.in b/man/man8/zfs-mount-generator.8.in index 41a2999f0..3b8c9c3ae 100644 --- a/man/man8/zfs-mount-generator.8.in +++ b/man/man8/zfs-mount-generator.8.in @@ -22,7 +22,7 @@ .\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION .\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -.TH "ZFS\-MOUNT\-GENERATOR" "8" "2020-01-19" "ZFS" "zfs-mount-generator" "\"" +.TH ZFS-MOUNT-GENERATOR 8 "Aug 24, 2020" OpenZFS .SH "NAME" zfs\-mount\-generator \- generates systemd mount units for ZFS diff --git a/man/man8/zinject.8 b/man/man8/zinject.8 index f02e78ca2..ee6776fe7 100644 --- a/man/man8/zinject.8 +++ b/man/man8/zinject.8 @@ -22,7 +22,7 @@ .\" .\" Copyright 2013 Darik Horn <[email protected]>. All rights reserved. .\" -.TH zinject 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands" +.TH ZINJECT 8 "Aug 24, 2020" OpenZFS .SH NAME zinject \- ZFS Fault Injector diff --git a/man/man8/zpool-iostat.8 b/man/man8/zpool-iostat.8 index c318dcd74..f91e55c3b 100644 --- a/man/man8/zpool-iostat.8 +++ b/man/man8/zpool-iostat.8 @@ -65,9 +65,9 @@ When given an .Ar interval , the statistics are printed every .Ar interval -seconds until ^C is pressed. If +seconds until ^C is pressed. If .Fl n -flag is specified the headers are displayed only once, otherwise they are +flag is specified the headers are displayed only once, otherwise they are displayed periodically. If count is specified, the command exits after count reports are printed. The first report printed is always the statistics since boot regardless of whether diff --git a/man/man8/zstreamdump.8 b/man/man8/zstreamdump.8 index 33cd047f5..f499be442 100644 --- a/man/man8/zstreamdump.8 +++ b/man/man8/zstreamdump.8 @@ -3,7 +3,7 @@ .\" 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 usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" 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] -.TH zstreamdump 8 "29 Aug 2012" "ZFS pool 28, filesystem 5" "System Administration Commands" +.TH ZSTREAMDUMP 8 "Aug 24, 2020" OpenZFS .SH NAME zstreamdump \- filter data in zfs send stream .SH SYNOPSIS |