Annotation of src/usr.bin/kdump/kdump.1, Revision 1.36
1.36 ! otto 1: .\" $OpenBSD: kdump.1,v 1.35 2022/07/30 07:19:30 jsg 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.36 ! otto 32: .Dd $Mdocdate: July 30 2022 $
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.34 schwarze 44: .Op Fl t Ar trstr
1.36 ! otto 45: .Op Fl u Ar label
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.5 aaron 62: .It Fl f Ar file
1.1 deraadt 63: Display the specified file instead of
64: .Pa ktrace.out .
1.33 tedu 65: Specifying
66: .Sq -
67: will read from standard input.
1.22 mikeb 68: .It Fl H
69: Display thread identifiers.
1.1 deraadt 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
1.12 jmc 76: bytes when decoding I/O.
1.1 deraadt 77: .It Fl n
78: Suppress ad hoc translations.
79: Normally
1.6 aaron 80: .Nm
1.4 aaron 81: tries to decode many system calls into a more human-readable format.
1.1 deraadt 82: For example,
83: .Xr ioctl 2
84: values are replaced with the macro name and
85: .Va errno
86: values are replaced with the
87: .Xr strerror 3
88: string.
89: Suppressing this feature yields a more consistent output format and is
90: easily amenable to further processing.
1.8 deraadt 91: .It Fl p Ar pid
92: Show output only for the
93: .Ar pid
94: specified.
1.1 deraadt 95: .It Fl R
96: Display relative timestamps (time since previous entry).
97: .It Fl T
1.15 jmc 98: Display absolute timestamps for each entry (seconds since the Epoch).
1.31 tedu 99: .It Fl TR
100: If both options are specified, display timestamps relative to trace start.
1.34 schwarze 101: .It Fl t Ar trstr
102: Select which tracepoints to display.
103: The argument can contain one or more of the letters
104: .Cm cinpstuxX+ .
1.14 jmc 105: See the
1.1 deraadt 106: .Fl t
107: option of
1.9 deraadt 108: .Xr ktrace 1
1.34 schwarze 109: for the meaning of the letters.
1.36 ! otto 110: .It Fl u Ar label
! 111: Display
! 112: .Xr utrace 2
! 113: tracepoints having
! 114: .XR utrace 2
! 115: label
! 116: .Ar label
! 117: as strings with
! 118: .Xr vis 3
! 119: escaping, without
! 120: .Xr ktrace 2
! 121: header information.
1.14 jmc 122: .It Fl X
123: Display I/O data with hexadecimal data and printable ASCII characters
124: side by side.
1.13 tedu 125: .It Fl x
126: Display I/O data in hexadecimal.
1.1 deraadt 127: .El
1.36 ! otto 128: .Pp
! 129: The
! 130: .Fl t
! 131: and
! 132: .Fl u
! 133: options are mutually exclusive,
! 134: the last one specified overrides any previous ones.
1.6 aaron 135: .Sh FILES
136: .Bl -tag -width ktrace.out -compact
137: .It Pa ktrace.out
138: default ktrace dump file
139: .El
1.1 deraadt 140: .Sh SEE ALSO
141: .Xr ktrace 1
142: .Sh HISTORY
143: The
1.6 aaron 144: .Nm
1.4 aaron 145: command appeared in
1.35 jsg 146: .Bx 4.3 Reno .