xref: /openbsd-src/usr.sbin/btrace/btrace.8 (revision cc3712eb6f43a750f086df3d2306a2829a285631)
1.\"	$OpenBSD: btrace.8,v 1.9 2023/09/15 10:56:46 claudio Exp $
2.\"
3.\" Copyright (c) 2019 Martin Pieuchot <mpi@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: September 15 2023 $
18.Dt BTRACE 8
19.Os
20.Sh NAME
21.Nm btrace
22.Nd bug tracer
23.Sh SYNOPSIS
24.Nm btrace
25.Op Fl lnv
26.Op Fl e Ar program | Ar file
27.Op Fl p Ar file
28.Op Ar argument ...
29.Sh DESCRIPTION
30The
31.Nm
32utility provides an interface to inspect the internals of the system and
33programs.
34It interprets the
35.Xr bt 5
36program in
37.Ar file
38and communicates with the dynamic tracer device using the interface described in
39.Xr dt 4 .
40.Pp
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl e Ar program
44Execute
45.Ar program .
46.It Fl l
47List all available probes.
48.It Fl n
49No action.
50Parse the program and then exit.
51.It Fl p Ar file
52Load symbols from
53.Ar file
54to convert
55.Va ustack
56addresses into function names.
57.It Fl v
58Verbose mode.
59Causes
60.Nm
61to print debugging messages.
62Multiple
63.Fl v
64options increase the verbosity.
65The maximum is 2.
66.El
67.Sh FILES
68.Bl -tag -width "/usr/share/btrace/XXXX" -compact
69.It Pa /usr/share/btrace/*
70collection of useful
71.Nm
72programs
73.El
74.Sh EXIT STATUS
75.Ex -std
76.Sh SEE ALSO
77.Xr dt 4 ,
78.Xr bt 5
79.Sh HISTORY
80The
81.Nm
82utility first appeared in
83.Ox 6.7 .
84.Sh AUTHORS
85.An Martin Pieuchot Aq Mt mpi@openbsd.org
86