From 38fe67abb4a10e5b53115635fe2fa11124efeab8 Mon Sep 17 00:00:00 2001 From: Brian Gianforcaro Date: Fri, 30 Apr 2021 22:40:02 -0700 Subject: [PATCH] Base: Add a man page for the 'bt' command. --- Base/usr/share/man/man1/bt.md | 44 +++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 Base/usr/share/man/man1/bt.md diff --git a/Base/usr/share/man/man1/bt.md b/Base/usr/share/man/man1/bt.md new file mode 100644 index 0000000000..5d48d85345 --- /dev/null +++ b/Base/usr/share/man/man1/bt.md @@ -0,0 +1,44 @@ +## Name + +bt - view the backtrace of the specified process + +## Synopsis + +```**sh +$ bt +``` + +## 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)