Initial import from FreeBSD RELENG_4:
[games.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 .\"
35 .Dd June 6, 1993
36 .Dt KDUMP 1
37 .Os
38 .Sh NAME
39 .Nm kdump
40 .Nd display kernel trace data
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl dnlRT
44 .Op Fl f Ar file
45 .Op Fl m Ar maxdata
46 .Op Fl t Op cnisuw
47 .Sh DESCRIPTION
48 The
49 .Nm
50 command displays the kernel trace files produced with
51 .Xr ktrace 1
52 in human readable format.
53 By default, the file
54 .Pa ktrace.out
55 in the current directory is displayed.
56 .Pp
57 The options are as follows:
58 .Bl -tag -width Fl
59 .It Fl d
60 Display all numbers in decimal.
61 .It Fl f Ar file
62 Display the specified file instead of
63 .Pa ktrace.out .
64 .It Fl l
65 Loop reading the trace file, once the end-of-file is reached, waiting for
66 more data.
67 .It Fl m Ar maxdata
68 Display at most
69 .Ar maxdata
70 bytes when decoding
71 .Tn I/O .
72 .It Fl n
73 Suppress ad hoc translations.
74 Normally
75 .Nm
76 tries to decode many system calls into a more human readable format.
77 For example,
78 .Xr ioctl 2
79 values are replaced with the macro name and
80 .Va errno
81 values are replaced with the
82 .Xr strerror 3
83 string.
84 Suppressing this feature yields a more consistent output format and is
85 easily amenable to further processing.
86 .It Fl R
87 Display relative timestamps (time since previous entry).
88 .It Fl T
89 Display absolute timestamps for each entry (seconds since epoch).
90 .It Fl t Ar cnisuw
91 See the
92 .Fl t
93 option of
94 .Xr ktrace 1 .
95 .El
96 .Sh SEE ALSO
97 .Xr ktrace 1
98 .Sh HISTORY
99 The
100 .Nm
101 command appeared in
102 .Bx 4.4 .