Differential D31929 Diff 102327 usr.bin/boottrace/boottrace.1

Changeset View

Standalone View

View Options

usr.bin/boottrace/boottrace.1

This file was added.

.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD

.\"

.\" 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.

.\"

.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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

pauamma_gundo.comUnsubmitted

Not Done

"THE REGENTS AND CONTRIBUTORS" of... NetApp? You probably want to run that boilerplate past your own lawyers.

pauamma_gundo.com: "THE REGENTS AND CONTRIBUTORS" of... NetApp? You probably want to run that boilerplate past…

.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 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.

.\"

.Dd January 17, 2022

.Dt BOOTTRACE 1

.Os

.Sh NAME

.Nm boottrace

.Nd trace command execution with

0mpUnsubmitted

Not Done

Idea: should we mention that it's about tracing time/duration here?

0mp: Idea: should we mention that it's about tracing time/duration here?

.Xr boottrace 4

.Sh SYNOPSIS

.Nm

.Ar utility Op Ar argument ...

.Sh DESCRIPTION

The

.Nm

utility

executes the specified

.Ar utility ,

creating two

.Xr boottrace 4

trace entries before and after its execution.

.Sh ENVIRONMENT

The

.Ev PATH

environment variable is used to locate the requested

.Ar utility

if the name contains no

.Ql /

characters.

pauamma_gundo.comUnsubmitted

Not Done

.Ar utility

- if the name contains no

+ if its pathname contains no

.Ql /

pauamma_gundo.com:

.Sh EXIT STATUS

.Ar utility

was executed successfully, its exit status is returned.

.Ar utility

terminated abnormally, a warning message is printed to stderr.

If the

.Ar utility

could not be found or run, an error message is printed to stderr, and

the

.Nm

program will terminate.

.Sh EXAMPLES

Execute the

.Xr dumpon 8

utility, logging the trace entries:

.Bd -literal -offset indent

$ boottrace dumpon -z /dev/gpt/swap0

0mpUnsubmitted

Not Done

If boottrace can only be executed by root, then the prompt should be #.

0mp: If boottrace can only be executed by root, then the prompt should be `#`.

.Ed

.Pp

This will appear in the output of

.Va sysctl kern.boottrace.log :

0mpUnsubmitted

Not Done

This will appear in the output of

- .Va sysctl kern.boottrace.log :

+ the

+ .Va kern.boottrace.log

+ .Xr sysctl 8

+ variable:

.Bd -literal -offset indent

The word "sysctl" should not be stylized with Va. I am attaching a possible fix.

0mp: The word "sysctl" should not be stylized with Va. I am attaching a possible fix.

.Bd -literal -offset indent

CPU msecs delta process event PID CPUtime IBlks OBlks

0 63918567 0 kernel (proc0) sysinit 0x2100001 0 0.00 0 0

\&...

0 64076940 120605 boottrace dumpon start 1602 0.00 0 0

0 64076942 2 boottrace dumpon done 1602 0.00 0 0

.Ed

.Sh SEE ALSO

.Xr boottrace 4 ,

debdrupUnsubmitted

Not Done

This part of the Examples subheader is too wide for terminals that are 80 characters in width, which needs to be addressed as all manual pages should be viewable in singleuser mode without any framebuffer in use.

debdrup: This part of the Examples subheader is too wide for terminals that are 80 characters in width…

mhorneAuthorUnsubmitted

Done

I can shrink it further I think, but do you have suggestions on how this is typically handled?

mhorne: I can shrink it further I think, but do you have suggestions on how this is typically handled?

debdrupUnsubmitted

Not Done

Nothing that's written down - I'd suggest using tmux or screen to create a 80 character wide pane/window and go from there.

I don't believe there's anything in the base system that exceeds 80 characters?

debdrup: Nothing that's written down - I'd suggest using tmux or screen to create a 80 character wide…

0mpUnsubmitted

Not Done

I think that this is not an issue. With less(1) you can scroll horizontally if needed. Also, the boottrace log just happens to have a lot of columns, which naturally makes it long. Some tools like netstat or ps print a a limited, narrow version of their outputs and allow the user to request a detailed, wide version with a special flag. I don't think we need this kind of functionality for boottrace sysctls.

0mp: I think that this is not an issue. With less(1) you can scroll horizontally if needed. Also…

.Xr rc.subr 8