Annotation of src/usr.bin/kdump/kdump.1, Revision 1.10
1.10 ! millert 1: .\" $OpenBSD: kdump.1,v 1.9 2003/02/19 19:30:13 deraadt 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: .\"
32: .Dd June 6, 1993
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
40: .Op Fl dnlRT
41: .Op Fl e Ar emulation
42: .Op Fl f Ar file
43: .Op Fl m Ar maxdata
1.8 deraadt 44: .Op Fl p Ar pid
1.9 deraadt 45: .Op Fl t Op ceinsw
1.1 deraadt 46: .Sh DESCRIPTION
1.6 aaron 47: .Nm
1.1 deraadt 48: displays the kernel trace files produced with
49: .Xr ktrace 1
1.4 aaron 50: in human-readable format.
1.1 deraadt 51: By default, the file
52: .Pa ktrace.out
1.9 deraadt 53: in the current directory is displayed, unless overridden by the
1.6 aaron 54: .Fl f
55: option.
1.1 deraadt 56: .Pp
57: The options are as follows:
1.6 aaron 58: .Bl -tag -width Ds
1.1 deraadt 59: .It Fl d
60: Display all numbers in decimal.
1.6 aaron 61: By default, values are printed out in hexadecimal.
1.1 deraadt 62: .It Fl e Ar emulation
1.6 aaron 63: Interpret system call maps assuming the named emulation instead of
64: .Qq bsd .
65: For example, to view trace output from a Linux binary, use
66: .Fl e Ar linux .
1.5 aaron 67: .It Fl f Ar file
1.1 deraadt 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.
1.5 aaron 73: .It Fl m Ar maxdata
1.1 deraadt 74: Display at most
75: .Ar maxdata
76: bytes when decoding
77: .Tn I/O .
78: .It Fl n
79: Suppress ad hoc translations.
80: Normally
1.6 aaron 81: .Nm
1.4 aaron 82: tries to decode many system calls into a more human-readable format.
1.1 deraadt 83: For example,
84: .Xr ioctl 2
85: values are replaced with the macro name and
86: .Va errno
87: values are replaced with the
88: .Xr strerror 3
89: string.
90: Suppressing this feature yields a more consistent output format and is
91: easily amenable to further processing.
1.8 deraadt 92: .It Fl p Ar pid
93: Show output only for the
94: .Ar pid
95: specified.
1.1 deraadt 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).
1.9 deraadt 100: .It Fl t Op ceinsw
101: Selects which tracepoints to display. See the
1.1 deraadt 102: .Fl t
103: option of
1.9 deraadt 104: .Xr ktrace 1
105: for the definitions of the flags.
1.1 deraadt 106: .El
1.6 aaron 107: .Sh FILES
108: .Bl -tag -width ktrace.out -compact
109: .It Pa ktrace.out
110: default ktrace dump file
111: .El
1.1 deraadt 112: .Sh SEE ALSO
113: .Xr ktrace 1
114: .Sh HISTORY
115: The
1.6 aaron 116: .Nm
1.4 aaron 117: command appeared in
1.1 deraadt 118: .Bx 4.4 .