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