xref: /freebsd/usr.sbin/boottrace/boottrace.8 (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
2.\"
3.\" Copyright (c) 2022 NetApp, Inc.
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 February 18, 2022
27.Dt BOOTTRACE 8
28.Os
29.Sh NAME
30.Nm boottrace
31.Nd trace command execution with
32.Xr boottrace 4
33.Sh SYNOPSIS
34.Nm
35.Ar utility Op Ar argument ...
36.Sh DESCRIPTION
37The
38.Nm
39utility
40executes the specified
41.Ar utility ,
42creating two
43.Xr boottrace 4
44trace entries before and after its execution.
45.Sh ENVIRONMENT
46The
47.Ev PATH
48environment variable is used to locate the requested
49.Ar utility
50if the name contains no
51.Ql /
52characters.
53.Sh EXIT STATUS
54If
55.Ar utility
56was executed successfully, its exit status is returned.
57.Pp
58If
59.Ar utility
60was found but could not be executed, an exit status of 126 is returned.
61If
62.Ar utility
63could not be found, an exit status of 127 is returned.
64.Sh EXAMPLES
65Execute the
66.Xr dumpon 8
67utility, logging the trace entries:
68.Bd -literal -offset indent
69$ boottrace dumpon -z /dev/gpt/swap0
70.Ed
71.Pp
72This will appear in the output of the
73.Va kern.boottrace.log
74.Xr sysctl 8
75node:
76.Bd -literal
77CPU      msecs    delta process     event                PID CPUtime IBlks OBlks
78  0   63918567        0 kernel      sysinit 0x2100001      0    0.00     0     0
79[...]
80  0   64076940   120605 boottrace   dumpon start        1602    0.00     0     0
81  0   64076942        2 boottrace   dumpon done         1602    0.00     0     0
82.Ed
83.Sh SEE ALSO
84.Xr boottrace 4 ,
85.Xr rc.subr 8
86