xref: /freebsd/usr.bin/ktrdump/ktrdump.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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.Dd October 22, 2018
27.Dt KTRDUMP 8
28.Os
29.Sh NAME
30.Nm ktrdump
31.Nd print kernel ktr trace buffer
32.Sh SYNOPSIS
33.Nm
34.Op Fl cflqrtH
35.Op Fl i Ar ktrfile
36.Op Fl M Ar core
37.Op Fl N Ar system
38.Op Fl o Ar outfile
39.Sh DESCRIPTION
40The
41.Nm
42utility is used to dump the contents of the kernel ktr trace buffer.
43.Pp
44The following options are available:
45.Bl -tag -width ".Fl i Ar ktrfile"
46.It Fl c
47Print the CPU number that each entry was logged from.
48.It Fl l
49Poll the kernel ktr trace buffer periodically dumping any new events after
50each poll.
51.It Fl f
52Print the file and line number that each entry was logged from.
53.It Fl q
54Quiet mode; do not print the column header.
55.It Fl r
56Print relative timestamps rather than absolute timestamps.
57.It Fl t
58Print the timestamp for each entry.
59.It Fl H
60Print the thread ID for each entry.
61.It Fl i Ar ktrfile
62File containing saved ktr trace events; for more information see the
63.Xr ktr 4
64manual page.
65.It Fl N Ar system
66The kernel image to resolve symbols from.
67The default is the value returned via
68.Xr getbootfile 3 .
69.It Fl M Ar core
70The core file or memory image to read from.
71The default is
72.Pa /dev/mem .
73.It Fl o Ar outfile
74The file to write the output to.
75The default is standard output.
76.El
77.Sh SEE ALSO
78.Xr ktr 4 ,
79.Xr ktr 9
80.Sh HISTORY
81The
82.Nm
83utility first appeared in
84.Fx 5.0 .
85.Sh AUTHORS
86.An -nosplit
87The
88.Nm
89utility was implemented by
90.An Jake Burkholder Aq Mt jake@FreeBSD.org .
91.Pp
92This manual page was written by
93.An Chad David Aq Mt davidc@FreeBSD.org .
94