Return to kdump.1 CVS log

Up to [local] / src / usr.bin / kdump

list tracepoints directly in kdump.1 instead of pointing to ktrace.1

Also add a note to the respective section in kdump.1, ktrace.1, and
ltrace.1 to keep in sync with each other; suggested by schwarze@.

ok deraadt@ schwarze@

.\"	$OpenBSD: kdump.1,v 1.38 2023/09/30 13:03:40 naddy Exp $
.\"
.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	from: @(#)kdump.1	8.1 (Berkeley) 6/6/93
.\"
.Dd $Mdocdate: September 30 2023 $
.Dt KDUMP 1
.Os
.Sh NAME
.Nm kdump
.Nd display kernel trace data
.Sh SYNOPSIS
.Nm kdump
.Op Fl dHlnRTXx
.Op Fl f Ar file
.Op Fl m Ar maxdata
.Op Fl p Ar pid
.Op Fl t Ar trstr
.Op Fl u Ar label
.Sh DESCRIPTION
.Nm
displays the kernel trace files produced with
.Xr ktrace 1
in human-readable format.
By default, the file
.Pa ktrace.out
in the current directory is displayed, unless overridden by the
.Fl f
option.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl d
Display all numbers in decimal.
By default, values are printed out in hexadecimal.
.It Fl f Ar file
Display the specified file instead of
.Pa ktrace.out .
Specifying
.Sq -
will read from standard input.
.It Fl H
Display thread identifiers.
.It Fl l
Loop reading the trace file, once the end-of-file is reached, waiting for
more data.
.It Fl m Ar maxdata
Display at most
.Ar maxdata
bytes when decoding I/O.
.It Fl n
Suppress ad hoc translations.
Normally
.Nm
tries to decode many system calls into a more human-readable format.
For example,
.Xr ioctl 2
values are replaced with the macro name and
.Va errno
values are replaced with the
.Xr strerror 3
string.
Suppressing this feature yields a more consistent output format and is
easily amenable to further processing.
.It Fl p Ar pid
Show output only for the
.Ar pid
specified.
.It Fl R
Display relative timestamps (time since previous entry).
.It Fl T
Display absolute timestamps for each entry (seconds since the Epoch).
.It Fl TR
If both options are specified, display timestamps relative to trace start.
.It Fl t Ar trstr
Select which tracepoints to display.
The argument can contain one or more of the following letters.
By default all trace points except for
.Cm X
are enabled.
.Pp
.Bl -tag -width flag -offset indent -compact
.\" Keep this list in sync with ktrace(1) and ltrace(1).
.It Cm c
trace system calls
.It Cm i
trace I/O
.It Cm n
trace namei translations
.It Cm p
trace violation of
.Xr pledge 2
restrictions
.It Cm s
trace signal processing
.It Cm t
trace various structures
.It Cm u
trace user data coming from
.Xr utrace 2
.It Cm x
trace argument vector in
.Xr execve 2
.It Cm X
trace environment in
.Xr execve 2
.It Cm +
trace the default points
.El
.It Fl u Ar label
Display
.Xr utrace 2
tracepoints having
.Xr utrace 2
label
.Ar label
as strings with
.Xr vis 3
escaping, without
.Xr ktrace 2
header information.
.It Fl X
Display I/O data with hexadecimal data and printable ASCII characters
side by side.
.It Fl x
Display I/O data in hexadecimal.
.El
.Pp
The
.Fl t
and
.Fl u
options are mutually exclusive;
the last one specified overrides any previous ones.
.Sh FILES
.Bl -tag -width ktrace.out -compact
.It Pa ktrace.out
default ktrace dump file
.El
.Sh SEE ALSO
.Xr ktrace 1
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 Reno .