usr.bin/kdump/kdump.1

   1 .\"     $NetBSD: kdump.1,v 1.25 2003/11/16 21:52:33 manu Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)kdump.1     8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd November 15, 2003
  33 .Dt KDUMP 1
  34 .Os
  35 .Sh NAME
  36 .Nm kdump
  37 .Nd display kernel trace data
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl dlNnRT
  41 .Op Fl e Ar emulation
  42 .Op Fl f Ar file
  43 .Op Fl m Ar maxdata
  44 .Op Fl p Ar pid
  45 .Op Fl t Ar trstr
  46 .Op Fl x | Fl X Ar size
  47 .Op Ar file
  48 .Sh DESCRIPTION
  49 .Nm
  50 displays the kernel trace files produced with
  51 .Xr ktrace 1
  52 in human readable format.
  53 The file
  54 .Pa ktrace.out
  55 in the current directory is displayed, unless either the
  56 .Fl f
  57 option is used, or a file name is supplied as the last argument.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width Fl
  61 .It Fl d
  62 Display all numbers in decimal.
  63 .It Fl e Ar emulation
  64 If an emulation of a process is unknown,
  65 interpret system call maps assuming the named emulation instead of
  66 default "netbsd".
  67 .It Fl f Ar file
  68 Display the specified file instead of
  69 .Pa ktrace.out .
  70 .It Fl l
  71 Loop reading the trace file, once the end-of-file is reached, waiting for
  72 more data.
  73 .It Fl m Ar maxdata
  74 Display at most
  75 .Ar maxdata
  76 bytes when decoding
  77 .Tn I/O .
  78 .It Fl N
  79 Suppress system call number-to-name translation.
  80 .It Fl n
  81 Suppress ad hoc translations.
  82 Normally
  83 .Nm
  84 tries to decode many system calls into a more human readable format.
  85 For example,
  86 .Xr ioctl 2
  87 values are replaced with the macro name and
  88 .Va errno
  89 values are replaced with the
  90 .Xr strerror 3
  91 string.
  92 Suppressing this feature yields a more consistent output format and is
  93 easily amenable to further processing.
  94 .It Fl p Ar pid
  95 Only display records from the trace file that are for the indicated pid.
  96 .It Fl R
  97 Display relative timestamps (time since previous entry).
  98 .It Fl T
  99 Display absolute timestamps for each entry (seconds since epoch).
 100 .It Fl t Ar trstr
 101 Restrict display to the specified set of kernel trace points.
 102 The default is to display everything in the file.
 103 See the
 104 .Fl t
 105 option of
 106 .Xr ktrace 1 .
 107 .It Fl x
 108 Display GIO data in hex and ascii instead of
 109 .Xr vis 3
 110 format.
 111 .It Fl X Ar size
 112 Same as
 113 .Fl x
 114 but display hex values by groups of
 115 .Ar size
 116 bytes.
 117 Supported values are 1, 2, 4, 8, and 16.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr ktrace 1
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 command appears in
 125 .Bx 4.4 .