xref: /openbsd-src/usr.sbin/btrace/btrace.8 (revision cc3712eb6f43a750f086df3d2306a2829a285631)
1*cc3712ebSclaudio.\"	$OpenBSD: btrace.8,v 1.9 2023/09/15 10:56:46 claudio Exp $
223160851Smpi.\"
323160851Smpi.\" Copyright (c) 2019 Martin Pieuchot <mpi@openbsd.org>
423160851Smpi.\"
523160851Smpi.\" Permission to use, copy, modify, and distribute this software for any
623160851Smpi.\" purpose with or without fee is hereby granted, provided that the above
723160851Smpi.\" copyright notice and this permission notice appear in all copies.
823160851Smpi.\"
923160851Smpi.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1023160851Smpi.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1123160851Smpi.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1223160851Smpi.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1323160851Smpi.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1423160851Smpi.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1523160851Smpi.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1623160851Smpi.\"
17*cc3712ebSclaudio.Dd $Mdocdate: September 15 2023 $
1823160851Smpi.Dt BTRACE 8
1923160851Smpi.Os
2023160851Smpi.Sh NAME
2123160851Smpi.Nm btrace
2223160851Smpi.Nd bug tracer
2323160851Smpi.Sh SYNOPSIS
2423160851Smpi.Nm btrace
258ffe87a0Sjmc.Op Fl lnv
2623160851Smpi.Op Fl e Ar program | Ar file
27*cc3712ebSclaudio.Op Fl p Ar file
2858afdee7Sdv.Op Ar argument ...
2923160851Smpi.Sh DESCRIPTION
3023160851SmpiThe
3123160851Smpi.Nm
3223160851Smpiutility provides an interface to inspect the internals of the system and
3323160851Smpiprograms.
3423160851SmpiIt interprets the
3523160851Smpi.Xr bt 5
3623160851Smpiprogram in
3723160851Smpi.Ar file
3858afdee7Sdvand communicates with the dynamic tracer device using the interface described in
3923160851Smpi.Xr dt 4 .
4023160851Smpi.Pp
4123160851SmpiThe options are as follows:
4223160851Smpi.Bl -tag -width Ds
4323160851Smpi.It Fl e Ar program
4423160851SmpiExecute
4523160851Smpi.Ar program .
4623160851Smpi.It Fl l
4723160851SmpiList all available probes.
48b69b24c5Sjmatthew.It Fl n
49b69b24c5SjmatthewNo action.
50b69b24c5SjmatthewParse the program and then exit.
51*cc3712ebSclaudio.It Fl p Ar file
52*cc3712ebSclaudioLoad symbols from
53*cc3712ebSclaudio.Ar file
54*cc3712ebSclaudioto convert
55*cc3712ebSclaudio.Va ustack
56*cc3712ebSclaudioaddresses into function names.
5723160851Smpi.It Fl v
5823160851SmpiVerbose mode.
5923160851SmpiCauses
6023160851Smpi.Nm
6123160851Smpito print debugging messages.
6223160851SmpiMultiple
6323160851Smpi.Fl v
6423160851Smpioptions increase the verbosity.
6523160851SmpiThe maximum is 2.
6623160851Smpi.El
67679d3e5fSbluhm.Sh FILES
68679d3e5fSbluhm.Bl -tag -width "/usr/share/btrace/XXXX" -compact
69679d3e5fSbluhm.It Pa /usr/share/btrace/*
70679d3e5fSbluhmcollection of useful
71679d3e5fSbluhm.Nm
72679d3e5fSbluhmprograms
73679d3e5fSbluhm.El
7423160851Smpi.Sh EXIT STATUS
7523160851Smpi.Ex -std
7623160851Smpi.Sh SEE ALSO
7723160851Smpi.Xr dt 4 ,
7823160851Smpi.Xr bt 5
7923160851Smpi.Sh HISTORY
8023160851SmpiThe
8123160851Smpi.Nm
8223160851Smpiutility first appeared in
8323160851Smpi.Ox 6.7 .
8423160851Smpi.Sh AUTHORS
8523160851Smpi.An Martin Pieuchot Aq Mt mpi@openbsd.org
86