Merge from vendor branch BIND:
[dragonfly.git] / usr.bin / ktrdump / ktrdump.8
1 .\"-
2 .\" Copyright (c) 2002 Chad David
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/usr.bin/ktrdump/ktrdump.8,v 1.7 2005/03/08 06:58:56 hmp Exp $
27 .\" $DragonFly: src/usr.bin/ktrdump/ktrdump.8,v 1.4 2005/06/21 06:50:28 dillon Exp $
28 .\"
29 .Dd May 5, 2004
30 .Dt KTRDUMP 8
31 .Os
32 .Sh NAME
33 .Nm ktrdump
34 .Nd print kernel ktr trace buffer
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl acfinpqrtx
38 .Op Fl N Ar execfile
39 .Op Fl M Ar corefile
40 .Op Fl o Ar outfile
41 .Sh DESCRIPTION
42 The
43 .Nm
44 utility is used to dump the contents of the kernel ktr trace buffer.
45 .Pp
46 The following options are available:
47 .Bl -tag -width ".Fl N Ar execfile"
48 .It Fl a
49 Print all fields.  Implies all print options.
50 .It Fl c
51 Print the CPU number that each entry was logged from.
52 .It Fl f
53 Print the file and line number that each entry was logged from.
54 .It Fl i
55 Print the ID string field, identifying the facility being logged.
56 .It Fl n
57 .Nm
58 normally tries to translate the caller fields and (when easily parsed)
59 trace arguments into symbols.  This option forces hex values to be
60 displayed instead.
61 .It Fl p
62 Print the trace data.
63 .It Fl q
64 Quiet mode; do not print the column header.
65 .It Fl r
66 Print relative timestamps rather than absolute timestamps.
67 .It Fl x
68 Print the call chain leading up to the procedure which issued
69 the KTR.
70 .It Fl t
71 Print the timestamp for each entry.
72 .Xr ktr 4
73 manual page.
74 .It Fl N Ar execfile
75 The kernel image to resolve symbols from.
76 The default is the value returned via
77 .Xr getbootfile 3 .
78 .It Fl M Ar corefile
79 The core file or memory image to read from.
80 The default is
81 .Pa /dev/mem .
82 .It Fl o Ar outfile
83 The file to write the output to.
84 The default is standard output.
85 .El
86 .Sh SEE ALSO
87 .Xr ktr 4 ,
88 .Xr ktr 9
89 .Sh HISTORY
90 The
91 .Nm
92 utility first appeared in
93 .Fx 5.0 .
94 .Sh AUTHORS
95 .An -nosplit
96 The
97 .Nm
98 utility was implemented by
99 .An Jake Burkholder Aq jake@FreeBSD.org .
100 .Pp
101 This manual page was written by
102 .An Chad David Aq davidc@FreeBSD.org .