c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2024-12-25 18:59:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Remove hard coded "Linux" OS from manpages

Browse Source 
The recommended practice for `.Os` on FreeBSD is to not specify any
arguments.  The correct OS name is used automatically.

Oddly enough, on the Linux distro I tested this on (CentOS 7), the man
pager defaulted to displaying "BSD" as the OS rather than "Linux".  To
accommodate this, tack " Linux" back on in an install hook on Linux.
This is much simpler than removing it for FreeBSD when vendored in the
base system.

Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ryan Moeller <ryan@iXsystems.com>
Closes #10760
This commit is contained in:
Ryan Moeller 2020-08-21 14:55:47 -04:00 committed by GitHub
parent 64025fa3a1
commit 6706552ea6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
65 changed files with 92 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
man/man1/Makefile.am
View File

@ -1,2 +1,12 @@
dist_man_MANS = zhack.1 ztest.1 raidz_test.1 zvol_wait.1 arcstat.1
EXTRA_DIST = cstyle.1
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)/man1; \
$(SED) ${ac_inplace} -e 's/^\.Os$$/.Os Linux/' \
$(dist_man_MANS)
endif

2
man/man1/zvol_wait.1
View File

@ -1,6 +1,6 @@
.Dd July 5, 2019
.Dt ZVOL_WAIT 1 SMM
.Os Linux
.Os
.Sh NAME
.Nm zvol_wait
.Nd Wait for ZFS volume links in

10
man/man5/Makefile.am
View File

@ -4,3 +4,13 @@ dist_man_MANS = \
spl-module-parameters.5 \
zfs-module-parameters.5 \
zfs-events.5
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)/man5; \
$(SED) ${ac_inplace} -e 's/^\.Os$$/.Os Linux/' \
$(dist_man_MANS)
endif

10
man/man8/Makefile.am
View File

@ -89,3 +89,13 @@ nodist_man_MANS = \
zfs-mount-generator.8
SUBSTFILES += $(nodist_man_MANS)
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)/man8; \
$(SED) ${ac_inplace} -e 's/^\.Os$$/.Os Linux/' \
$(dist_man_MANS) $(nodist_man_MANS)
endif

2
man/man8/zdb.8
View File

@ -17,7 +17,7 @@
.\"
.Dd April 14, 2019
.Dt ZDB 8 SMM
.Os Linux
.Os
.Sh NAME
.Nm zdb
.Nd display zpool debugging and consistency information

2
man/man8/zfs-allow.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-ALLOW 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm allow
.Nd Delegates ZFS administration permission for the file systems to non-privileged users.

2
man/man8/zfs-bookmark.8
View File

@ -33,7 +33,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-BOOKMARK 8 SMM
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm bookmark
.Nd Creates a bookmark of the given snapshot.

2
man/man8/zfs-clone.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-CLONE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm clone
.Nd Creates a clone of the given snapshot.

2
man/man8/zfs-create.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-CREATE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm create
.Nd Creates a new ZFS file system.

2
man/man8/zfs-destroy.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-DESTROY 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm destroy
.Nd Destroys the given dataset(s), snapshot(s), or bookmark.

2
man/man8/zfs-diff.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-DIFF 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm diff
.Nd Display the difference between two snapshots of a given filesystem.

2
man/man8/zfs-hold.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-HOLD 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm hold
.Nd Hold a snapshot to prevent it being removed with the zfs destroy command.

2
man/man8/zfs-list.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-LIST 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm list
.Nd Lists the property information for the given datasets in tabular form.

2
man/man8/zfs-load-key.8
View File

@ -32,7 +32,7 @@
.\"
.Dd January 13, 2020
.Dt ZFS-LOAD-KEY 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm load-key
.Nd Load, unload, or change the encryption key used to access a dataset.

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

@ -32,7 +32,7 @@
.\"
.Dd February 16, 2019
.Dt ZFS-MOUNT 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm mount
.Nd Manage mount state of ZFS file systems.

2
man/man8/zfs-project.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-PROJECT 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm project
.Nd List, set, or clear project ID and/or inherit flag on the file(s) or directories.

2
man/man8/zfs-promote.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-PROMOTE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm promote
.Nd Promotes a clone file system to no longer be dependent on its origin snapshot.

2
man/man8/zfs-receive.8
View File

@ -32,7 +32,7 @@
.\"
.Dd February 16, 2020
.Dt ZFS-RECEIVE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm receive
.Nd Creates a snapshot whose contents are as specified in the stream provided on standard input.

2
man/man8/zfs-rename.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-RENAME 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm rename
.Nd Renames the given dataset (filesystem or snapshot).

2
man/man8/zfs-rollback.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-ROLLBACK 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm rollback
.Nd Roll back the given dataset to a previous snapshot.

2
man/man8/zfs-send.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-SEND 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm send
.Nd Generate a send stream, which may be of a filesystem, and may be incremental from a bookmark.

2
man/man8/zfs-set.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-SET 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm set
.Nd Sets the property or list of properties to the given value(s) for each dataset.

2
man/man8/zfs-share.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-SHARE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm share
.Nd Shares and unshares available ZFS filesystems.

2
man/man8/zfs-snapshot.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-SNAPSHOT 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm snapshot
.Nd Creates snapshots with the given names.

2
man/man8/zfs-upgrade.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-UPGRADE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm upgrade
.Nd Manage upgrading the on-disk version of filesystems.

2
man/man8/zfs-userspace.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS-USERSPACE 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm userspace
.Nd Displays space consumed by, and quotas on, each user or group in the specified filesystem or snapshot.

2
man/man8/zfs-wait.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZFS-WAIT 8
.Os Linux
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm wait
.Nd Wait for background activity to stop in a ZFS filesystem

2
man/man8/zfs.8
View File

@ -39,7 +39,7 @@
.\"
.Dd June 30, 2019
.Dt ZFS 8
.Os Linux
.Os
.Sh NAME
.Nm zfs
.Nd configures ZFS file systems

2
man/man8/zfs_ids_to_path.8
View File

@ -22,7 +22,7 @@
.\" Copyright (c) 2020 by Delphix. All rights reserved.
.Dd April 17, 2020
.Dt ZFS_IDS_TO_PATH 8
.Os Linux
.Os
.Sh NAME
.Nm zfs_ids_to_path
.Nd convert objset and object ids to names and paths

2
man/man8/zfsconcepts.8
View File

@ -32,7 +32,7 @@
.\"
.Dd June 30, 2019
.Dt ZFSCONCEPTS 8
.Os Linux
.Os
.Sh NAME
.Nm zfsconcepts
.Nd An overview of ZFS concepts.

2
man/man8/zfsprops.8
View File

@ -40,7 +40,7 @@
.\"
.Dd January 30, 2020
.Dt ZFSPROPS 8
.Os Linux
.Os
.Sh NAME
.Nm zfsprops
.Nd Native properties and user-defined of ZFS datasets.

2
man/man8/zgenhostid.8
View File

@ -23,7 +23,7 @@
.\"
.Dd September 16, 2017
.Dt ZGENHOSTID 8 SMM
.Os Linux
.Os
.Sh NAME
.Nm zgenhostid
.Nd generate and store a hostid in

2
man/man8/zpool-add.8
View File

@ -28,7 +28,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-ADD 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm add
.Nd Adds specified virtual devices to a ZFS storage pool

2
man/man8/zpool-attach.8
View File

@ -29,7 +29,7 @@
.\"
.Dd May 15, 2020
.Dt ZPOOL-ATTACH 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm attach
.Nd Attach a new device to an existing ZFS virtual device (vdev).

2
man/man8/zpool-checkpoint.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-CHECKPOINT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm checkpoint
.Nd Checkpoints the current state of a ZFS storage pool

2
man/man8/zpool-clear.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-CLEAR 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm clear
.Nd Clears device errors in a ZFS storage pool.

2
man/man8/zpool-create.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-CREATE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm create
.Nd Creates a new ZFS storage pool

2
man/man8/zpool-destroy.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-DESTROY 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm destroy
.Nd Destroys the given ZFS storage pool, freeing up any devices for other use

2
man/man8/zpool-detach.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-DETACH 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm detach
.Nd Detaches a device from a ZFS mirror vdev (virtual device)

2
man/man8/zpool-events.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-EVENTS 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm events
.Nd Lists all recent events generated by the ZFS kernel modules

2
man/man8/zpool-export.8
View File

@ -29,7 +29,7 @@
.\"
.Dd February 16, 2020
.Dt ZPOOL-EXPORT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm export
.Nd Exports the given ZFS storage pools from the system

2
man/man8/zpool-get.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-GET 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm get
.Nd Retrieves properties for the specified ZFS storage pool(s)

2
man/man8/zpool-history.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-HISTORY 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm history
.Nd Displays the command history of the specified ZFS storage pool(s)

2
man/man8/zpool-import.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-IMPORT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm import
.Nd Lists ZFS storage pools available to import or import the specified pools

2
man/man8/zpool-initialize.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-INITIALIZE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm initialize
.Nd Write to all unallocated regions of eligible devices in a ZFS storage pool

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

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-IOSTAT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm iostat
.Nd Display logical I/O statistics for the given ZFS storage pools/vdevs

2
man/man8/zpool-labelclear.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-LABELCLEAR 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm labelclear
.Nd Removes ZFS label information from the specified physical device

2
man/man8/zpool-list.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-LIST 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm list
.Nd Lists ZFS storage pools along with a health status and space usage

2
man/man8/zpool-offline.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-OFFLINE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm offline
.Nd Take a physical device in a ZFS storage pool offline

2
man/man8/zpool-reguid.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-REGUID 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm reguid
.Nd Generate a new unique identifier for a ZFS storage pool

2
man/man8/zpool-remove.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-REMOVE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm remove
.Nd Remove a device from a ZFS storage pool

2
man/man8/zpool-reopen.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-REOPEN 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm reopen
.Nd Reopen all virtual devices (vdevs) associated with a ZFS storage pool

2
man/man8/zpool-replace.8
View File

@ -29,7 +29,7 @@
.\"
.Dd May 15, 2020
.Dt ZPOOL-REPLACE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm replace
.Nd Replace one device with another in a ZFS storage pool

2
man/man8/zpool-resilver.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-RESILVER 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm resilver
.Nd Start a resilver of a device in a ZFS storage pool

2
man/man8/zpool-scrub.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-SCRUB 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm scrub
.Nd Begin a scrub or resume a paused scrub of a ZFS storage pool

2
man/man8/zpool-split.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-SPLIT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm split
.Nd Split devices off a ZFS storage pool creating a new pool

2
man/man8/zpool-status.8
View File

@ -29,7 +29,7 @@
.\"
.Dd May 15, 2020
.Dt ZPOOL-STATUS 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm status
.Nd Display detailed health status for the given ZFS storage pools

2
man/man8/zpool-sync.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-SYNC 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm sync
.Nd Force data to be written to primary storage of a ZFS storage pool and update reporting data

2
man/man8/zpool-trim.8
View File

@ -29,7 +29,7 @@
.\"
.Dd February 25, 2020
.Dt ZPOOL-TRIM 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm trim
.Nd Initiate immediate TRIM operations for all free space in a ZFS storage pool

2
man/man8/zpool-upgrade.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL-UPGRADE 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm upgrade
.Nd Manage version and feature flags of ZFS storage pools

2
man/man8/zpool-wait.8
View File

@ -29,7 +29,7 @@
.\"
.Dd February 25, 2020
.Dt ZPOOL-WAIT 8
.Os Linux
.Os
.Sh NAME
.Nm zpool Ns Pf - Cm wait
.Nd Wait for background activity to stop in a ZFS storage pool

2
man/man8/zpool.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOL 8
.Os Linux
.Os
.Sh NAME
.Nm zpool
.Nd configure ZFS storage pools

2
man/man8/zpoolconcepts.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOLCONCEPTS 8
.Os Linux
.Os
.Sh NAME
.Nm zpoolconcepts
.Nd overview of ZFS storage pools

2
man/man8/zpoolprops.8
View File

@ -29,7 +29,7 @@
.\"
.Dd August 9, 2019
.Dt ZPOOLPROPS 8
.Os Linux
.Os
.Sh NAME
.Nm zpoolprops
.Nd available properties for ZFS storage pools

2
man/man8/zstream.8
View File

@ -22,7 +22,7 @@
.\" Copyright (c) 2020 by Delphix. All rights reserved.
.Dd March 25, 2020
.Dt ZSTREAM 8
.Os Linux
.Os
.Sh NAME
.Nm zstream
.Nd manipulate zfs send streams