Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

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 <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Ryan Moeller <ryan@iXsystems.com>
Closes #10792
This commit is contained in:
Ryan Moeller 2020-08-25 00:25:28 -04:00 committed by GitHub
parent b900799768
commit b596585fd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/man1/arcstat.1
View File

@ -13,7 +13,7 @@
.\" Copyright (c) 2015 by Delphix. All rights reserved. .\" Copyright (c) 2015 by Delphix. All rights reserved.
.\" Copyright (c) 2020 by AJ Jordan. 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 .SH NAME
arcstat \- report ZFS ARC and L2ARC statistics arcstat \- report ZFS ARC and L2ARC statistics
.SH SYNOPSIS .SH SYNOPSIS

2
man/man1/cstyle.1
View File

@ -20,7 +20,7 @@
.\" .\"
.\" CDDL HEADER END .\" CDDL HEADER END
.\" .\"
.TH cstyle 1 "28 March 2005" .TH CSTYLE 1 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
.I cstyle .I cstyle
\- check for some common stylistic errors in C source files \- check for some common stylistic errors in C source files

2
man/man1/raidz_test.1
View File

@ -22,7 +22,7 @@
.\" .\"
.\" Copyright (c) 2016 Gvozden Nešković. All rights reserved. .\" 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 .SH NAME
\fBraidz_test\fR \- raidz implementation verification and benchmarking tool \fBraidz_test\fR \- raidz implementation verification and benchmarking tool

2
man/man1/zhack.1
View File

@ -22,7 +22,7 @@
.\" .\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved. .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
.\" .\"
.TH zhack 1 "2013 MAR 16" "ZFS on Linux" "User Commands" .TH ZHACK 1 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
zhack \- libzpool debugging tool zhack \- libzpool debugging tool

2
man/man1/ztest.1
View File

@ -24,7 +24,7 @@
.\" Copyright (c) 2009 Michael Gebetsroither <michael.geb@gmx.at>. All rights .\" Copyright (c) 2009 Michael Gebetsroither <michael.geb@gmx.at>. All rights
.\" reserved. .\" reserved.
.\" .\"
.TH ztest 1 "2009 NOV 01" "ZFS on Linux" "User Commands" .TH ZTEST 1 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
\fBztest\fR \- was written by the ZFS Developers as a ZFS unit test. \fBztest\fR \- was written by the ZFS Developers as a ZFS unit test.

4
man/man5/spl-module-parameters.5
View File

@ -2,7 +2,7 @@
.\" .\"
.\" Copyright 2013 Turbo Fredriksson <turbo@bayour.com>. All rights reserved. .\" Copyright 2013 Turbo Fredriksson <turbo@bayour.com>. All rights reserved.
.\" .\"
.TH SPL-MODULE-PARAMETERS 5 "Oct 28, 2017" .TH SPL-MODULE-PARAMETERS 5 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
spl\-module\-parameters \- SPL module parameters spl\-module\-parameters \- SPL module parameters
.SH DESCRIPTION .SH DESCRIPTION
@ -225,7 +225,7 @@ Default value: \fB/etc/hostid\fR
\fBspl_panic_halt\fR (uint) \fBspl_panic_halt\fR (uint)
.ad .ad
.RS 12n .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. halted to facilitate further debugging.
.sp .sp
Set to a non-zero value to enable. Set to a non-zero value to enable.

2
man/man5/vdev_id.conf.5
View File

@ -1,4 +1,4 @@
.TH vdev_id.conf 5 .TH VDEV_ID.CONF 5 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
vdev_id.conf \- Configuration file for vdev_id vdev_id.conf \- Configuration file for vdev_id
.SH DESCRIPTION .SH DESCRIPTION

2
man/man5/zfs-events.5
View File

@ -13,7 +13,7 @@
.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
.\" own identifying information: .\" own identifying information:
.\" Portions Copyright [yyyy] [name of copyright owner] .\" Portions Copyright [yyyy] [name of copyright owner]
.TH ZFS-EVENTS 5 "Oct 24, 2018" .TH ZFS-EVENTS 5 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
zfs\-events \- Events created by the ZFS filesystem. zfs\-events \- Events created by the ZFS filesystem.
.SH DESCRIPTION .SH DESCRIPTION

6
man/man5/zfs-module-parameters.5
View File

@ -14,7 +14,7 @@
.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
.\" own identifying information: .\" own identifying information:
.\" Portions Copyright [yyyy] [name of copyright owner] .\" 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 .SH NAME
zfs\-module\-parameters \- ZFS module parameters zfs\-module\-parameters \- ZFS module parameters
.SH DESCRIPTION .SH DESCRIPTION
@ -426,7 +426,7 @@ Default value: \fB16,777,216\fR (16MB)
.RS 12n .RS 12n
If we are not searching forward (due to metaslab_df_max_search, If we are not searching forward (due to metaslab_df_max_search,
metaslab_df_free_pct, or metaslab_df_alloc_threshold), this tunable controls 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 If it is not set, we will use a segment of exactly the requested size (or
larger). larger).
.sp .sp
@ -3256,7 +3256,7 @@ Default value: \fB25\fR.
\fBzfs_sync_pass_dont_compress\fR (int) \fBzfs_sync_pass_dont_compress\fR (int)
.ad .ad
.RS 12n .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, With the default setting, in practice, we don't have this many sync passes,
so this has no effect. so this has no effect.
.sp .sp

2
man/man5/zpool-features.5
View File

@ -16,7 +16,7 @@
.\" Portions Copyright [yyyy] [name of copyright owner] .\" Portions Copyright [yyyy] [name of copyright owner]
.\" Copyright (c) 2019, Klara Inc. .\" Copyright (c) 2019, Klara Inc.
.\" Copyright (c) 2019, Allan Jude .\" Copyright (c) 2019, Allan Jude
.TH ZPOOL-FEATURES 5 "Jun 8, 2018" .TH ZPOOL-FEATURES 5 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
zpool\-features \- ZFS pool feature descriptions zpool\-features \- ZFS pool feature descriptions
.SH DESCRIPTION .SH DESCRIPTION

2
man/man8/fsck.zfs.8
View File

@ -22,7 +22,7 @@
.\" .\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved. .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. 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 .SH NAME
fsck.zfs \- Dummy ZFS filesystem checker. fsck.zfs \- Dummy ZFS filesystem checker.

2
man/man8/mount.zfs.8
View File

@ -22,7 +22,7 @@
.\" .\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved. .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. 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 .SH NAME
mount.zfs \- mount a ZFS filesystem mount.zfs \- mount a ZFS filesystem

2
man/man8/vdev_id.8
View File

@ -1,4 +1,4 @@
.TH vdev_id 8 .TH VDEV_ID 8 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
vdev_id \- generate user-friendly names for JBOD disks vdev_id \- generate user-friendly names for JBOD disks
.SH SYNOPSIS .SH SYNOPSIS

2
man/man8/zed.8.in
View File

@ -11,7 +11,7 @@
.\" "OPENSOLARIS.LICENSE" or at <http://opensource.org/licenses/CDDL-1.0>. .\" "OPENSOLARIS.LICENSE" or at <http://opensource.org/licenses/CDDL-1.0>.
.\" You may not use this file except in compliance with the license. .\" 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 .SH NAME
ZED \- ZFS Event Daemon ZED \- ZFS Event Daemon

2
man/man8/zfs-mount-generator.8.in
View File

@ -22,7 +22,7 @@
.\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION .\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
.\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .\" 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" .SH "NAME"
zfs\-mount\-generator \- generates systemd mount units for ZFS zfs\-mount\-generator \- generates systemd mount units for ZFS

2
man/man8/zinject.8
View File

@ -22,7 +22,7 @@
.\" .\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved. .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
.\" .\"
.TH zinject 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands" .TH ZINJECT 8 "Aug 24, 2020" OpenZFS
.SH NAME .SH NAME
zinject \- ZFS Fault Injector zinject \- ZFS Fault Injector

4
man/man8/zpool-iostat.8
View File

@ -65,9 +65,9 @@ When given an
.Ar interval , .Ar interval ,
the statistics are printed every the statistics are printed every
.Ar interval .Ar interval
seconds until ^C is pressed. If seconds until ^C is pressed. If
.Fl n .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 displayed periodically. If count is specified, the command exits
after count reports are printed. The first report printed is always after count reports are printed. The first report printed is always
the statistics since boot regardless of whether the statistics since boot regardless of whether

2
man/man8/zstreamdump.8
View File

@ -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. .\" 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 .\" 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] .\" 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 .SH NAME
zstreamdump \- filter data in zfs send stream zstreamdump \- filter data in zfs send stream
.SH SYNOPSIS .SH SYNOPSIS