cddl/contrib/opensolaris/cmd/zdb/zdb.8

   1 '\" te
   2 .\" CDDL HEADER START
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  21 .TH zdb 1M "31 Oct 2005" "SunOS 5.11" "System Administration Commands"
  22 .SH NAME
  23 zdb \- ZFS debugger
  24 .SH SYNOPSIS
  25 .LP
  26 .nf
  27 \fBzdb\fR \fIpool\fR
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 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.
  34 .sp
  35 .LP
  36 If no arguments are specified, \fBzdb\fR, performs basic consistency checks on the pool and associated datasets, and report any problems detected.
  37 .sp
  38 .LP
  39 Any options supported by this command are internal to Sun and subject to change at any time.
  40 .SH EXIT STATUS
  41 .sp
  42 .LP
  43 The following exit values are returned:
  44 .sp
  45 .ne 2
  46 .mk
  47 .na
  48 \fB\fB0\fR\fR
  49 .ad
  50 .RS 5n
  51 .rt
  52 The pool is consistent.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .mk
  58 .na
  59 \fB\fB1\fR\fR
  60 .ad
  61 .RS 5n
  62 .rt
  63 An error was detected.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .mk
  69 .na
  70 \fB\fB2\fR\fR
  71 .ad
  72 .RS 5n
  73 .rt
  74 Invalid command line options were specified.
  75 .RE
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 tab(\a) box;
  86 cw(2.75i) |cw(2.75i)
  87 lw(2.75i) |lw(2.75i)
  88 .
  89 ATTRIBUTE TYPE\aATTRIBUTE VALUE
  90 _
  91 Availability\aSUNWzfsu
  92 _
  93 Interface Stability\aUnstable
  94 .TE
  95
  96 .SH SEE ALSO
  97 .sp
  98 .LP
  99 \fBzfs\fR(1M), \fBzpool\fR(1M), \fBattributes\fR(5)