xref: /openbsd-src/usr.bin/kdump/kdump.1 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: kdump.1,v 1.32 2016/07/18 09:36:50 guenther 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.\"	from: @(#)kdump.1	8.1 (Berkeley) 6/6/93
31.\"
32.Dd $Mdocdate: July 18 2016 $
33.Dt KDUMP 1
34.Os
35.Sh NAME
36.Nm kdump
37.Nd display kernel trace data
38.Sh SYNOPSIS
39.Nm kdump
40.Op Fl dHlnRTXx
41.Op Fl f Ar file
42.Op Fl m Ar maxdata
43.Op Fl p Ar pid
44.Op Fl t Op Cm cinpstuxX+
45.Sh DESCRIPTION
46.Nm
47displays the kernel trace files produced with
48.Xr ktrace 1
49in human-readable format.
50By default, the file
51.Pa ktrace.out
52in the current directory is displayed, unless overridden by the
53.Fl f
54option.
55.Pp
56The options are as follows:
57.Bl -tag -width Ds
58.It Fl d
59Display all numbers in decimal.
60By default, values are printed out in hexadecimal.
61.It Fl f Ar file
62Display the specified file instead of
63.Pa ktrace.out .
64.It Fl H
65Display thread identifiers.
66.It Fl l
67Loop reading the trace file, once the end-of-file is reached, waiting for
68more data.
69.It Fl m Ar maxdata
70Display at most
71.Ar maxdata
72bytes when decoding I/O.
73.It Fl n
74Suppress ad hoc translations.
75Normally
76.Nm
77tries to decode many system calls into a more human-readable format.
78For example,
79.Xr ioctl 2
80values are replaced with the macro name and
81.Va errno
82values are replaced with the
83.Xr strerror 3
84string.
85Suppressing this feature yields a more consistent output format and is
86easily amenable to further processing.
87.It Fl p Ar pid
88Show output only for the
89.Ar pid
90specified.
91.It Fl R
92Display relative timestamps (time since previous entry).
93.It Fl T
94Display absolute timestamps for each entry (seconds since the Epoch).
95.It Fl TR
96If both options are specified, display timestamps relative to trace start.
97.It Fl t Op Cm cinpstuxX+
98Selects which tracepoints to display.
99See the
100.Fl t
101option of
102.Xr ktrace 1
103for the definitions of the flags.
104.It Fl X
105Display I/O data with hexadecimal data and printable ASCII characters
106side by side.
107.It Fl x
108Display I/O data in hexadecimal.
109.El
110.Sh FILES
111.Bl -tag -width ktrace.out -compact
112.It Pa ktrace.out
113default ktrace dump file
114.El
115.Sh SEE ALSO
116.Xr ktrace 1
117.Sh HISTORY
118The
119.Nm
120command appeared in
121.Bx 4.4 .
122