Merge from vendor branch OPENSSH:
[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.4 2006/07/20 22:57:47 corecode 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 dnlRT
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 f Ar file
64 Display the specified file instead of
65 .Pa ktrace.out .
66 .It Fl l
67 Loop reading the trace file, once the end-of-file is reached, waiting for
68 more data.
69 .It Fl m Ar maxdata
70 Display at most
71 .Ar maxdata
72 bytes when decoding
73 .Tn I/O ;
74 set to
75 .Cm 0
76 to disable the size limit.
77 .It Fl p Ar pid
78 Display only records for process
79 .Ar pid .
80 .It Fl n
81 Suppress ad hoc translations.
82 Normally
83 .Nm
84 tries to decode many system calls into a more human readable format.
85 For example,
86 .Xr ioctl 2
87 values are replaced with the macro name and
88 .Va errno
89 values are replaced with the
90 .Xr strerror 3
91 string.
92 Suppressing this feature yields a more consistent output format and is
93 easily amenable to further processing.
94 .It Fl R
95 Display relative timestamps (time since previous entry).
96 .It Fl T
97 Display absolute timestamps for each entry (seconds since epoch).
98 .It Fl t Ar cnisuw
99 See the
100 .Fl t
101 option of
102 .Xr ktrace 1 .
103 .El
104 .Sh SEE ALSO
105 .Xr ktrace 1
106 .Sh HISTORY
107 The
108 .Nm
109 command appeared in
110 .Bx 4.4 .