freebsd-dev/man/man8/zfs_ids_to_path.8
Ryan Moeller 6706552ea6
Remove hard coded "Linux" OS from manpages
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
2020-08-21 11:55:47 -07:00

51 lines
1.4 KiB
Groff

.\"
.\" CDDL HEADER START
.\"
.\" 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]
.\"
.\" CDDL HEADER END
.\"
.\"
.\" Copyright (c) 2020 by Delphix. All rights reserved.
.Dd April 17, 2020
.Dt ZFS_IDS_TO_PATH 8
.Os
.Sh NAME
.Nm zfs_ids_to_path
.Nd convert objset and object ids to names and paths
.Sh SYNOPSIS
.Nm
.Op Fl v
.Ar pool
.Ar objset id
.Ar object id
.Nm
.Sh DESCRIPTION
.Pp
.LP
The
.Sy zfs_ids_to_path
utility converts a provided objset and object id into a path to the file that
those ids refer to.
.Bl -tag -width "-D"
.It Fl v
Verbose.
Print the dataset name and the file path within the dataset separately. This
will work correctly even if the dataset is not mounted.
.Sh SEE ALSO
.Xr zfs 8 ,
.Xr zdb 8