Annotation of src/usr.bin/kdump/kdump.1, Revision 1.22
1.22 ! mikeb 1: .\" $OpenBSD: kdump.1,v 1.21 2011/07/28 10:33:36 otto Exp $
1.7 aaron 2: .\"
1.1 deraadt 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.
1.10 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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: .\" from: @(#)kdump.1 8.1 (Berkeley) 6/6/93
31: .\"
1.22 ! mikeb 32: .Dd $Mdocdate: July 28 2011 $
1.1 deraadt 33: .Dt KDUMP 1
1.5 aaron 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm kdump
37: .Nd display kernel trace data
38: .Sh SYNOPSIS
39: .Nm kdump
1.12 jmc 40: .Bk -words
1.22 ! mikeb 41: .Op Fl dHlnRrTXx
1.1 deraadt 42: .Op Fl e Ar emulation
43: .Op Fl f Ar file
44: .Op Fl m Ar maxdata
1.8 deraadt 45: .Op Fl p Ar pid
1.9 deraadt 46: .Op Fl t Op ceinsw
1.12 jmc 47: .Ek
1.1 deraadt 48: .Sh DESCRIPTION
1.6 aaron 49: .Nm
1.1 deraadt 50: displays the kernel trace files produced with
51: .Xr ktrace 1
1.4 aaron 52: in human-readable format.
1.1 deraadt 53: By default, the file
54: .Pa ktrace.out
1.9 deraadt 55: in the current directory is displayed, unless overridden by the
1.6 aaron 56: .Fl f
57: option.
1.1 deraadt 58: .Pp
59: The options are as follows:
1.6 aaron 60: .Bl -tag -width Ds
1.1 deraadt 61: .It Fl d
62: Display all numbers in decimal.
1.6 aaron 63: By default, values are printed out in hexadecimal.
1.1 deraadt 64: .It Fl e Ar emulation
1.6 aaron 65: Interpret system call maps assuming the named emulation instead of
66: .Qq bsd .
67: For example, to view trace output from a Linux binary, use
68: .Fl e Ar linux .
1.5 aaron 69: .It Fl f Ar file
1.1 deraadt 70: Display the specified file instead of
71: .Pa ktrace.out .
1.22 ! mikeb 72: .It Fl H
! 73: Display thread identifiers.
1.1 deraadt 74: .It Fl l
75: Loop reading the trace file, once the end-of-file is reached, waiting for
76: more data.
1.5 aaron 77: .It Fl m Ar maxdata
1.1 deraadt 78: Display at most
79: .Ar maxdata
1.12 jmc 80: bytes when decoding I/O.
1.1 deraadt 81: .It Fl n
82: Suppress ad hoc translations.
83: Normally
1.6 aaron 84: .Nm
1.4 aaron 85: tries to decode many system calls into a more human-readable format.
1.1 deraadt 86: For example,
87: .Xr ioctl 2
88: values are replaced with the macro name and
89: .Va errno
90: values are replaced with the
91: .Xr strerror 3
92: string.
93: Suppressing this feature yields a more consistent output format and is
94: easily amenable to further processing.
1.8 deraadt 95: .It Fl p Ar pid
96: Show output only for the
97: .Ar pid
98: specified.
1.1 deraadt 99: .It Fl R
100: Display relative timestamps (time since previous entry).
1.18 otto 101: .It Fl r
1.21 otto 102: When decoding the name in
103: .Xr sysctl 3
104: CALL records or structure members in STRU records
105: (UIDs, GIDs, dates, etc),
106: display symbolically instead of numerically.
1.1 deraadt 107: .It Fl T
1.15 jmc 108: Display absolute timestamps for each entry (seconds since the Epoch).
1.20 otto 109: .It Fl t Op ceinstw
1.14 jmc 110: Selects which tracepoints to display.
111: See the
1.1 deraadt 112: .Fl t
113: option of
1.9 deraadt 114: .Xr ktrace 1
1.11 jmc 115: for the definitions of the flags.
1.14 jmc 116: .It Fl X
117: Display I/O data with hexadecimal data and printable ASCII characters
118: side by side.
1.13 tedu 119: .It Fl x
120: Display I/O data in hexadecimal.
1.1 deraadt 121: .El
1.6 aaron 122: .Sh FILES
123: .Bl -tag -width ktrace.out -compact
124: .It Pa ktrace.out
125: default ktrace dump file
126: .El
1.1 deraadt 127: .Sh SEE ALSO
128: .Xr ktrace 1
129: .Sh HISTORY
130: The
1.6 aaron 131: .Nm
1.4 aaron 132: command appeared in
1.1 deraadt 133: .Bx 4.4 .