Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple man-pages: Move to appropriate section #12149

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ AC_CONFIG_FILES([
man/Makefile
man/man1/Makefile
man/man5/Makefile
man/man7/Makefile
man/man8/Makefile
module/Kbuild
module/Makefile
Expand Down
2 changes: 1 addition & 1 deletion man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1 +1 @@
SUBDIRS = man1 man5 man8
SUBDIRS = man1 man5 man7 man8
6 changes: 1 addition & 5 deletions man/man5/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
dist_man_MANS = \
vdev_id.conf.5 \
zpool-features.5 \
spl-module-parameters.5 \
zfs-module-parameters.5 \
zfs-events.5
vdev_id.conf.5

if BUILD_LINUX
# The man pager in most Linux distros defaults to BSD instead of Linux
Expand Down
19 changes: 19 additions & 0 deletions man/man7/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
dist_man_MANS = \
spl-module-parameters.7 \
zfsconcepts.7 \
zfsprops.7 \
zfs-events.7 \
zfs-module-parameters.7 \
zpoolconcepts.7 \
zpoolprops.7 \
zpool-features.7

if BUILD_LINUX
# The man pager in most Linux distros defaults to BSD instead of Linux
# when .Os is blank, but leaving it blank makes things a lot easier on
# FreeBSD when OpenZFS is vendored in the base system.
install-data-hook:
cd $(DESTDIR)$(mandir)/man7; \
$(SED) ${ac_inplace} -e 's/^\.Os$$/.Os Linux/' \
$(dist_man_MANS)
endif
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\"
.\" Copyright 2013 Turbo Fredriksson <[email protected]>. All rights reserved.
.\"
.TH SPL-MODULE-PARAMETERS 5 "Aug 24, 2020" OpenZFS
.TH SPL-MODULE-PARAMETERS 7 "Aug 24, 2020" OpenZFS
.SH NAME
spl\-module\-parameters \- SPL module parameters
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion man/man5/zfs-events.5 → man/man7/zfs-events.7
Original file line number Diff line number Diff line change
Expand Up @@ -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 "Aug 24, 2020" OpenZFS
.TH ZFS-EVENTS 7 "Aug 24, 2020" OpenZFS
.SH NAME
zfs\-events \- Events created by the ZFS filesystem.
.SH DESCRIPTION
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 "May 5, 2021" OpenZFS
.TH ZFS-MODULE-PARAMETERS 7 "May 5, 2021" OpenZFS
.SH NAME
zfs\-module\-parameters \- ZFS module parameters
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfsconcepts.8 → man/man7/zfsconcepts.7
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
.\" Copyright 2019 Joyent, Inc.
.\"
.Dd June 30, 2019
.Dt ZFSCONCEPTS 8
.Dt ZFSCONCEPTS 7
.Os
.Sh NAME
.Nm zfsconcepts
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfsprops.8 → man/man7/zfsprops.7
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
.\" Copyright (c) 2019, Kjeld Schouten-Lebbing
.\"
.Dd May 24, 2021
.Dt ZFSPROPS 8
.Dt ZFSPROPS 7
.Os
.Sh NAME
.Nm zfsprops
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion man/man8/zpoolconcepts.8 → man/man7/zpoolconcepts.7
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
.\"
.Dd August 9, 2019
.Dt ZPOOLCONCEPTS 8
.Dt ZPOOLCONCEPTS 7
.Os
.Sh NAME
.Nm zpoolconcepts
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpoolprops.8 → man/man7/zpoolprops.7
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
.\" Copyright (c) 2021, Colm Buckley <[email protected]>
.\"
.Dd August 9, 2019
.Dt ZPOOLPROPS 8
.Dt ZPOOLPROPS 7
.Os
.Sh NAME
.Nm zpoolprops
Expand Down
4 changes: 0 additions & 4 deletions man/man8/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ dist_man_MANS = \
vdev_id.8 \
zdb.8 \
zfs.8 \
zfsconcepts.8 \
zfsprops.8 \
zfs-allow.8 \
zfs-bookmark.8 \
zfs-change-key.8 \
Expand Down Expand Up @@ -48,8 +46,6 @@ dist_man_MANS = \
zgenhostid.8 \
zinject.8 \
zpool.8 \
zpoolconcepts.8 \
zpoolprops.8 \
zpool-add.8 \
zpool-attach.8 \
zpool-checkpoint.8 \
Expand Down
2 changes: 1 addition & 1 deletion man/man8/mount.zfs.8
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ in most cases.
are handled according to the
.Em Temporary Mount Point Properties
section in
.Xr zfsprops 8 ,
.Xr zfsprops 7 ,
except for those described below.
.Pp
If
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-bookmark.8
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ a redaction bookmark.
.Pp
This feature must be enabled to be used.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy bookmarks
feature.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-clone.8
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
See the
.Em Clones
section of
.Xr zfsconcepts 8
.Xr zfsconcepts 7
for details.
The target dataset can be located anywhere in the ZFS hierarchy, and is created
as the same type as the original.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-create.8
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ See
in the
.Em Native Properties
section of
.Xr zfsprops 8
.Xr zfsprops 7
for more information about sparse volumes.
.It Fl n
Do a dry-run
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-jail.8
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ from the jail identified by JID
.El
.Sh SEE ALSO
.Xr jail 8 ,
.Xr zfsprops 8
.Xr zfsprops 7
6 changes: 3 additions & 3 deletions man/man8/zfs-list.8
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The property must be:
One of the properties described in the
.Em Native Properties
section of
.Xr zfsprops 8
.Xr zfsprops 7
.It
A user property
.It
Expand Down Expand Up @@ -130,7 +130,7 @@ value of the property.
The property must be one of the properties described in the
.Em Properties
section of
.Xr zfsprops 8
.Xr zfsprops 7
or the value
.Sy name
to sort by the dataset name.
Expand Down Expand Up @@ -171,4 +171,4 @@ displays only snapshots.
.El
.Sh SEE ALSO
.Xr zfs-get 8 ,
.Xr zfsprops 8
.Xr zfsprops 7
2 changes: 1 addition & 1 deletion man/man8/zfs-load-key.8
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,4 @@ are equivalent in a dataset and will incur an extra CPU cost per block written.
.Sh SEE ALSO
.Xr zfs-create 8 ,
.Xr zfs-set 8 ,
.Xr zfsprops 8
.Xr zfsprops 7
2 changes: 1 addition & 1 deletion man/man8/zfs-mount.8
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ duration of the mount.
See the
.Em Temporary Mount Point Properties
section of
.Xr zfsprops 8
.Xr zfsprops 7
for details.
.It Fl l
Load keys for encrypted filesystems as they are being mounted. This is
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-receive.8
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ To use this flag, the storage pool must have the
.Sy extensible_dataset
feature enabled.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags.
.It Fl u
File system that is associated with the received stream is not mounted.
Expand Down
8 changes: 4 additions & 4 deletions man/man8/zfs-send.8
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The receiving system must have the
.Sy large_blocks
pool feature enabled as well.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy large_blocks
feature.
Expand Down Expand Up @@ -159,7 +159,7 @@ received as an encrypted dataset, since encrypted datasets cannot use the
.Sy embedded_data
feature.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy embedded_data
feature.
Expand Down Expand Up @@ -302,7 +302,7 @@ The receiving system must have the
.Sy large_blocks
pool feature enabled as well.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy large_blocks
feature.
Expand Down Expand Up @@ -364,7 +364,7 @@ received as an encrypted dataset, since encrypted datasets cannot use the
.Sy embedded_data
feature.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy embedded_data
feature.
Expand Down
10 changes: 5 additions & 5 deletions man/man8/zfs-set.8
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
.Xc
Only some properties can be edited.
See
.Xr zfsprops 8
.Xr zfsprops 7
for more information on what properties can be set and acceptable
values.
Numeric values can be specified as exact values, or in a human-readable form
Expand All @@ -77,7 +77,7 @@ User properties can be set on snapshots.
For more information, see the
.Em User Properties
section of
.Xr zfsprops 8 .
.Xr zfsprops 7 .
.It Xo
.Nm zfs
.Cm get
Expand Down Expand Up @@ -109,7 +109,7 @@ This command takes a comma-separated list of properties as described in the
and
.Em User Properties
sections of
.Xr zfsprops 8 .
.Xr zfsprops 7 .
.Pp
The value
.Sy all
Expand Down Expand Up @@ -170,7 +170,7 @@ restored to default if no ancestor has the property set, or with the
.Fl S
option reverted to the received value if one exists.
See
.Xr zfsprops 8
.Xr zfsprops 7
for a listing of default values, and details on which properties can be
inherited.
.Bl -tag -width "-r"
Expand All @@ -185,4 +185,4 @@ option was not specified.
.El
.Sh SEE ALSO
.Xr zfs-list 8 ,
.Xr zfsprops 8
.Xr zfsprops 7
2 changes: 1 addition & 1 deletion man/man8/zfs-share.8
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ The command can also be given a path to a ZFS file system shared on the system.
.Sh SEE ALSO
.Xr exports 5 ,
.Xr smb.conf 5 ,
.Xr zfsprops 8
.Xr zfsprops 7
2 changes: 1 addition & 1 deletion man/man8/zfs-snapshot.8
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ can be used as an alias for
See the
.Em Snapshots
section of
.Xr zfsconcepts 8
.Xr zfsconcepts 7
for details.
.Bl -tag -width "-o"
.It Fl o Ar property Ns = Ns Ar value
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-userspace.8
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@ for types.
.El
.Sh SEE ALSO
.Xr zfs-set 8 ,
.Xr zfsprops 8
.Xr zfsprops 7
8 changes: 4 additions & 4 deletions man/man8/zfs.8
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ or
.El
.Pp
For details see
.Xr zfsconcepts 8 .
.Xr zfsconcepts 7 .
.Ss Properties
Properties are divided into two types, native properties and user-defined
.Po or
Expand All @@ -111,7 +111,7 @@ In addition, native properties are either editable or read-only.
User properties have no effect on ZFS behavior, but you can use them to annotate
datasets in a way that is meaningful in your environment.
For more information about properties, see the
.Xr zfsprops 8 man page.
.Xr zfsprops 7.
.Ss Encryption
Enabling the
.Sy encryption
Expand Down Expand Up @@ -772,6 +772,6 @@ to mount zfs datasets. This option is provided for backwards compatibility with
.Xr zfs-upgrade 8 ,
.Xr zfs-userspace 8 ,
.Xr zfs-wait 8 ,
.Xr zfsconcepts 8 ,
.Xr zfsprops 8 ,
.Xr zfsconcepts 7 ,
.Xr zfsprops 7 ,
.Xr zpool 8
2 changes: 1 addition & 1 deletion man/man8/zgenhostid.8
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ and ovewrite the file if it exists
.Xr genhostid 1 ,
.Xr hostid 1 ,
.Xr sethostid 3 ,
.Xr spl-module-parameters 5
.Xr spl-module-parameters 7
.Sh HISTORY
.Nm
emulates the
Expand Down
4 changes: 2 additions & 2 deletions man/man8/zpool-add.8
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The
specification is described in the
.Em Virtual Devices
section of
.Xr zpoolconcepts 8.
.Xr zpoolconcepts 7 .
The behavior of the
.Fl f
option, and the device checks performed are described in the
Expand Down Expand Up @@ -89,7 +89,7 @@ conjunction with the
flag.
.It Fl o Ar property Ns = Ns Ar value
Sets the given pool properties. See the
.Xr zpoolprops 8
.Xr zpoolprops 7
manual page for a list of valid properties that can be set. The only property
supported at the moment is ashift.
.El
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool-attach.8
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ even if it appears to be in use.
Not all devices can be overridden in this manner.
.It Fl o Ar property Ns = Ns Ar value
Sets the given pool properties. See the
.Xr zpoolprops 8
.Xr zpoolprops 7
manual page for a list of valid properties that can be set. The only property
supported at the moment is ashift.
.It Fl s
Expand Down
Loading