Base: Add a man page for the 'bt' command.

This commit is contained in:
Brian Gianforcaro 2021-04-30 22:40:02 -07:00 committed by Linus Groh
parent ca213ab374
commit 38fe67abb4
Notes: sideshowbarker 2024-07-18 18:50:35 +09:00

View file

@ -0,0 +1,44 @@
## Name
bt - view the backtrace of the specified process
## Synopsis
```**sh
$ bt <pid>
```
## Description
This program is used to inspect the current executable state of a process.
It will read the stack of each thread in the process, and symbolize the
addresses for each frame in the stack producing a backtrace.
**NOTE**:
* Kernel addresses will not be available unless you are super user.
* If Kernel addresses are available, they will not be symbolized unless the
`SymbolServer` service has access to the `/boot/Kernel` file.
## Examples
View all stacks of pid number 10:
```sh
$ bt 10
```
Use [`watch`(1)](watch.md) to emit a backtrace of pid 124, every second:
```sh
$ watch -n 1 -- bt 124
```
## See also
* [`Inspector`(1)](Inspector.md)
* [`Profiler`(1)](Profiler.md)
* [`watch`(1)](watch.md)