bb23d8278fb7e2f48ef4904f71969a7628fa7a11
[dragonfly.git] / usr.bin / kdump / kdump.1
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 djnlRT
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
50 The
51 .Nm
52 command displays the kernel trace files produced with
53 .Xr ktrace 1
54 in human readable format.
55 By default, the file
56 .Pa ktrace.out
57 in the current directory is displayed.
58 .Pp
59 The options are as follows:
60 .Bl -tag -width Fl
61 .It Fl d
62 Display all numbers in decimal.
63 .It Fl j
64 Use a fixed format output, otherwise a more human readable output is used.
65 .It Fl f Ar file
66 Display the specified file instead of
67 .Pa ktrace.out .
68 .It Fl l
69 Loop reading the trace file, once the end-of-file is reached, waiting for
70 more data.
71 .It Fl m Ar maxdata
72 Display at most
73 .Ar maxdata
74 bytes when decoding
75 .Tn I/O ;
76 set to
77 .Cm 0
78 to disable the size limit.
79 .It Fl p Ar pid
80 Display only records for process
81 .Ar pid .
82 .It Fl n
83 Suppress ad hoc translations.
84 Normally
85 .Nm
86 tries to decode many system calls into a more human readable format.
87 For example,
88 .Xr ioctl 2
89 values are replaced with the macro name and
90 .Va errno
91 values are replaced with the
92 .Xr strerror 3
93 string.
94 Suppressing this feature yields a more consistent output format and is
95 easily amenable to further processing.
96 .It Fl R
97 Display relative timestamps (time since previous entry).
98 .It Fl T
99 Display absolute timestamps for each entry (seconds since epoch).
100 .It Fl t Ar cnisuw
101 See the
102 .Fl t
103 option of
104 .Xr ktrace 1 .
105 .El
106 .Sh SEE ALSO
107 .Xr ktrace 1
108 .Sh HISTORY
109 The
110 .Nm
111 command appeared in
112 .Bx 4.4 .