Annotation of src/usr.bin/kdump/kdump.1, Revision 1.30
1.30 ! guenther 1: .\" $OpenBSD: kdump.1,v 1.29 2016/02/28 15:55:58 naddy 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.30 ! guenther 32: .Dd $Mdocdate: February 28 2016 $
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.24 guenther 40: .Op Fl dHlnRTXx
1.1 deraadt 41: .Op Fl f Ar file
42: .Op Fl m Ar maxdata
1.8 deraadt 43: .Op Fl p Ar pid
1.30 ! guenther 44: .Op Fl t Op Cm cinstuxX+
1.1 deraadt 45: .Sh DESCRIPTION
1.6 aaron 46: .Nm
1.1 deraadt 47: displays the kernel trace files produced with
48: .Xr ktrace 1
1.4 aaron 49: in human-readable format.
1.1 deraadt 50: By default, the file
51: .Pa ktrace.out
1.9 deraadt 52: in the current directory is displayed, unless overridden by the
1.6 aaron 53: .Fl f
54: option.
1.1 deraadt 55: .Pp
56: The options are as follows:
1.6 aaron 57: .Bl -tag -width Ds
1.1 deraadt 58: .It Fl d
59: Display all numbers in decimal.
1.6 aaron 60: By default, values are printed out in hexadecimal.
1.5 aaron 61: .It Fl f Ar file
1.1 deraadt 62: Display the specified file instead of
63: .Pa ktrace.out .
1.22 mikeb 64: .It Fl H
65: Display thread identifiers.
1.1 deraadt 66: .It Fl l
67: Loop reading the trace file, once the end-of-file is reached, waiting for
68: more data.
1.5 aaron 69: .It Fl m Ar maxdata
1.1 deraadt 70: Display at most
71: .Ar maxdata
1.12 jmc 72: bytes when decoding I/O.
1.1 deraadt 73: .It Fl n
74: Suppress ad hoc translations.
75: Normally
1.6 aaron 76: .Nm
1.4 aaron 77: tries to decode many system calls into a more human-readable format.
1.1 deraadt 78: For example,
79: .Xr ioctl 2
80: values are replaced with the macro name and
81: .Va errno
82: values are replaced with the
83: .Xr strerror 3
84: string.
85: Suppressing this feature yields a more consistent output format and is
86: easily amenable to further processing.
1.8 deraadt 87: .It Fl p Ar pid
88: Show output only for the
89: .Ar pid
90: specified.
1.1 deraadt 91: .It Fl R
92: Display relative timestamps (time since previous entry).
93: .It Fl T
1.15 jmc 94: Display absolute timestamps for each entry (seconds since the Epoch).
1.30 ! guenther 95: .It Fl t Op Cm cinstuxX+
1.14 jmc 96: Selects which tracepoints to display.
97: See the
1.1 deraadt 98: .Fl t
99: option of
1.9 deraadt 100: .Xr ktrace 1
1.11 jmc 101: for the definitions of the flags.
1.14 jmc 102: .It Fl X
103: Display I/O data with hexadecimal data and printable ASCII characters
104: side by side.
1.13 tedu 105: .It Fl x
106: Display I/O data in hexadecimal.
1.1 deraadt 107: .El
1.6 aaron 108: .Sh FILES
109: .Bl -tag -width ktrace.out -compact
110: .It Pa ktrace.out
111: default ktrace dump file
112: .El
1.1 deraadt 113: .Sh SEE ALSO
114: .Xr ktrace 1
115: .Sh HISTORY
116: The
1.6 aaron 117: .Nm
1.4 aaron 118: command appeared in
1.1 deraadt 119: .Bx 4.4 .