xref: /netbsd-src/usr.bin/kdump/kdump.1 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: kdump.1,v 1.28 2017/09/10 10:09:34 wiz 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.\"	@(#)kdump.1	8.1 (Berkeley) 6/6/93
31.\"
32.Dd September 9, 2017
33.Dt KDUMP 1
34.Os
35.Sh NAME
36.Nm kdump
37.Nd display kernel trace data
38.Sh SYNOPSIS
39.Nm
40.Op Fl dElNnRT
41.Op Fl e Ar emulation
42.Op Fl f Ar file
43.Op Fl m Ar maxdata
44.Op Fl p Ar pid
45.Op Fl t Ar trstr
46.Op Fl x | Fl X Ar size
47.Op Ar file
48.Sh DESCRIPTION
49.Nm
50displays the kernel trace files produced with
51.Xr ktrace 1
52in human readable format.
53The file
54.Pa ktrace.out
55in the current directory is displayed, unless either the
56.Fl f
57option is used, or a file name is supplied as the last argument.
58.Pp
59The options are as follows:
60.Bl -tag -width Fl
61.It Fl d
62Display all numbers in decimal.
63.It Fl E
64Display elapsed timestamps (time since beginning of trace).
65.It Fl e Ar emulation
66If an emulation of a process is unknown,
67interpret system call maps assuming the named emulation instead of
68default "netbsd".
69.It Fl f Ar file
70Display the specified file instead of
71.Pa ktrace.out .
72.It Fl l
73Loop reading the trace file, once the end-of-file is reached, waiting for
74more data.
75.It Fl m Ar maxdata
76Display at most
77.Ar maxdata
78bytes when decoding I/O.
79.It Fl N
80Suppress system call number-to-name translation.
81.It Fl n
82Suppress ad hoc translations.
83Normally
84.Nm
85tries to decode many system calls into a more human readable format.
86For example,
87.Xr ioctl 2
88values are replaced with the macro name and
89.Va errno
90values are replaced with the
91.Xr strerror 3
92string.
93Suppressing this feature yields a more consistent output format and is
94easily amenable to further processing.
95.It Fl p Ar pid
96Only display records from the trace file that are for the indicated pid.
97.It Fl R
98Display relative timestamps (time since previous entry).
99.It Fl T
100Display absolute timestamps for each entry (seconds since epoch).
101.It Fl t Ar trstr
102Restrict display to the specified set of kernel trace points.
103The default is to display everything in the file.
104See the
105.Fl t
106option of
107.Xr ktrace 1 .
108.It Fl x
109Display GIO data in hex and ascii instead of
110.Xr vis 3
111format.
112.It Fl X Ar size
113Same as
114.Fl x
115but display hex values by groups of
116.Ar size
117bytes.
118Supported values are 1, 2, 4, 8, and 16.
119.El
120.Sh SEE ALSO
121.Xr ktrace 1
122.Sh HISTORY
123The
124.Nm
125command appears in
126.Bx 4.4 .
127