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