xref: /dragonfly/usr.bin/kdump/kdump.1 (revision 25a2db75)
1.\" Copyright (c) 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)kdump.1	8.1 (Berkeley) 6/6/93
33.\" $FreeBSD: src/usr.bin/kdump/kdump.1,v 1.5.2.2 2001/08/16 13:16:51 ru Exp $
34.\" $DragonFly: src/usr.bin/kdump/kdump.1,v 1.5 2007/05/07 15:43:31 dillon Exp $
35.\"
36.Dd June 6, 1993
37.Dt KDUMP 1
38.Os
39.Sh NAME
40.Nm kdump
41.Nd display kernel trace data
42.Sh SYNOPSIS
43.Nm
44.Op Fl acdjnlRT
45.Op Fl f Ar file
46.Op Fl m Ar maxdata
47.Op Fl t Op cnisuw
48.Op Fl p Ar pid
49.Sh DESCRIPTION
50The
51.Nm
52command displays the kernel trace files produced with
53.Xr ktrace 1
54in human readable format.
55By default, the file
56.Pa ktrace.out
57in the current directory is displayed.
58.Pp
59The options are as follows:
60.Bl -tag -width Fl
61.It Fl a
62Display full human readable output.
63This option turns on
64.Fl c
65and
66.Fl R .
67.It Fl c
68Display the cpu the thread is executing on.
69.It Fl d
70Display all numbers in decimal.
71.It Fl j
72Use a fixed format output, otherwise a more human readable output is used.
73.It Fl f Ar file
74Display the specified file instead of
75.Pa ktrace.out .
76.It Fl l
77Loop reading the trace file, once the end-of-file is reached, waiting for
78more data.
79.It Fl m Ar maxdata
80Display at most
81.Ar maxdata
82bytes when decoding
83.Tn I/O ;
84set to
85.Cm 0
86to disable the size limit.
87.It Fl p Ar pid
88Display only records for process
89.Ar pid .
90.It Fl n
91Suppress ad hoc translations.
92Normally
93.Nm
94tries to decode many system calls into a more human readable format.
95For example,
96.Xr ioctl 2
97values are replaced with the macro name and
98.Va errno
99values are replaced with the
100.Xr strerror 3
101string.
102Suppressing this feature yields a more consistent output format and is
103easily amenable to further processing.
104.It Fl R
105Display relative timestamps (time since previous entry).
106.It Fl T
107Display absolute timestamps for each entry (seconds since epoch).
108.It Fl t Ar cnisuw
109See the
110.Fl t
111option of
112.Xr ktrace 1 .
113.El
114.Sh SEE ALSO
115.Xr ktrace 1
116.Sh HISTORY
117The
118.Nm
119command appeared in
120.Bx 4.4 .
121