d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update ZFS manual pages to a mdoc(7) reimplementation.

Browse Source 
The zfs(8) and zpool(8) manual pages now match the state of the ZFS module
and have been customized for FreeBSD.

The new texts of the "Deduplication" subsection in zfs(8), the zpool "split"
command, the zfs "dedup" property and several other missing parts have been
added from illumos or OpenSolaris snv_134 (CDDL-licensed).

The mdoc(7) reimplementation of whole manual pages, the descriptions of the
zpool "readonly" property, "zfs diff" command and descriptions of several
other missing command flags and/or options were authored by myself.

MFC after:	1 week
This commit is contained in:
mm 2011-11-27 11:44:20 +00:00
parent 39c8d59a00
commit 3fe92eb448
4 changed files with 4445 additions and 5005 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
cddl/contrib/opensolaris/cmd/zdb/zdb.8
View File

@ -1,65 +1,79 @@
'\" te
.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>.
.\" All Rights Reserved.
.\"
.\" 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]
.\"
.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.\" 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]
.\" Portions Copyright 2011 Martin Matuska <mm@FreeBSD.org>
.TH ZDB 8 "Oct 31, 2005"
.SH NAME
zdb \- ZFS debugger
.SH SYNOPSIS
.LP
.nf
\fBzdb\fR \fIpool\fR
.fi
.SH DESCRIPTION
.sp
.LP
The \fBzdb\fR command is used by support engineers to diagnose failures and
gather statistics. Since the \fBZFS\fR file system is always consistent on disk
and is self-repairing, \fBzdb\fR should only be run under the direction by a
support engineer.
.sp
.LP
If no arguments are specified, \fBzdb\fR, performs basic consistency checks on
the pool and associated datasets, and report any problems detected.
.sp
.LP
.\"
.\" $FreeBSD$
.\"
.Dd November 26, 2011
.Dt ZDB 8
.Os
.Sh NAME
.Nm zdb
.Nd ZFS debugger
.Sh SYNOPSIS
.Nm
.Ar pool
.Sh DESCRIPTION
The
.Nm
command is used by support engineers to diagnose failures and
gather statistics. Since the
.Tn ZFS
file system is always consistent on disk and is self-repairing,
.Nm
should only be run under the direction by a support engineer.
.Pp
If no arguments are specified,
.Nm
performs basic consistency checks on the pool and associated datasets, and
report any problems detected.
.Nm
Any options supported by this command are internal to Sun and subject to change
at any time.
.SH EXIT STATUS
.sp
.LP
.Sh EXIT STATUS
The following exit values are returned:
.sp
.ne 2
.na
\fB\fB0\fR\fR
.ad
.RS 5n
.Bl -tag -offset 2n -width 2n
.It 0
The pool is consistent.
.RE
.sp
.ne 2
.na
\fB\fB1\fR\fR
.ad
.RS 5n
.It 1
An error was detected.
.RE
.sp
.ne 2
.na
\fB\fB2\fR\fR
.ad
.RS 5n
.It 2
Invalid command line options were specified.
.RE
.SH SEE ALSO
.sp
.LP
zfs(8), zpool(8)
.El
.Sh SEE ALSO
.Xr zfs 8 ,
.Xr zpool 8
.Sh AUTHORS
This manual page is a
.Xr mdoc 7
reimplementation of the
.Tn OpenSolaris
manual page
.Em zdb(1M) ,
modified and customized for
.Fx
and licensed under the
.Tn Common Development and Distribution License
.Pq Tn CDDL .
.Pp
The
.Xr mdoc 7
implementation of this manual page was initially written by
.An Martin Matuska Aq mm@FreeBSD.org .

5806
cddl/contrib/opensolaris/cmd/zfs/zfs.8
View File

File diff suppressed because it is too large Load Diff

3408
cddl/contrib/opensolaris/cmd/zpool/zpool.8
View File

File diff suppressed because it is too large Load Diff

106
cddl/contrib/opensolaris/cmd/zstreamdump/zstreamdump.1
View File

@ -1,49 +1,67 @@
'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
.\" 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]
.\" Portions Copyright 2011 Martin Matuska <mm@FreeBSD.org>
.TH ZSTREAMDUMP 1 "Sep 21, 2009"
.SH NAME
zstreamdump \- filter data in zfs send stream
.SH SYNOPSIS
.LP
.nf
\fBzstreamdump\fR [\fB-C\fR] [\fB-v\fR]
.fi
.SH DESCRIPTION
.sp
.LP
The \fBzstreamdump\fR utility reads from the output of the \fBzfs send\fR
.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>.
.\" All Rights Reserved.
.\"
.\" 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]
.\"
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
.\"
.\" $FreeBSD$
.\"
.Dd November 26, 2011
.Dt ZSTREAMDUMP 8
.Os
.Sh NAME
.Nm zdb
.Nd filter data in zfs send stream
.Sh SYNOPSIS
.Nm
.Op Fl C
.Op Fl v
.Sh DESCRIPTION
The
.Nm
utility reads from the output of the
.Qq Nm zfs Cm send
command, then displays headers and some statistics from that output. See
\fBzfs\fR(1M).
.SH OPTIONS
.sp
.LP
.Xr zfs 8 .
.Pp
The following options are supported:
.sp
.ne 2
.na
\fB\fB-C\fR\fR
.ad
.sp .6
.RS 4n
.Bl -tag -width indent
.It Fl C
Suppress the validation of checksums.
.RE
.sp
.ne 2
.na
\fB\fB-v\fR\fR
.ad
.sp .6
.RS 4n
.It Fl v
Verbose. Dump all headers, not only begin and end headers.
.RE
.SH SEE ALSO
.sp
.LP
zfs(8)
.El
.Sh SEE ALSO
.Xr zfs 8
.Sh AUTHORS
This manual page is a
.Xr mdoc 7
reimplementation of the
.Tn OpenSolaris
manual page
.Em zstreamdump(1M) ,
modified and customized for
.Fx
and licensed under the
.Tn Common Development and Distribution License
.Pq Tn CDDL .
.Pp
The
.Xr mdoc 7
implementation of this manual page was initially written by
.An Martin Matuska Aq mm@FreeBSD.org .