diff options
author | Brendan Coles <bcoles@gmail.com> | 2021-02-24 15:40:36 +0000 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2021-02-24 20:40:00 +0100 |
commit | 0ffc06b795865314009c29b6930cab3603e7bcec (patch) | |
tree | ac05afef52f746eb9f4ce2d443d13f30a4319107 /Base/usr | |
parent | 8f867df31aaa249e100ade75d314a4037a8dfb96 (diff) | |
download | serenity-0ffc06b795865314009c29b6930cab3603e7bcec.zip |
Profiler: Add help documentation
Diffstat (limited to 'Base/usr')
-rw-r--r-- | Base/usr/share/man/man1/Profiler.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/Profiler.md b/Base/usr/share/man/man1/Profiler.md new file mode 100644 index 0000000000..8cdfb1e4d1 --- /dev/null +++ b/Base/usr/share/man/man1/Profiler.md @@ -0,0 +1,47 @@ +## Name + +Profiler - Serenity process profiler + +## Synopsis + +```**sh +$ Profiler [--pid PID] [perfcore file] +``` + +## Description + +Profiler facilitates process performance profiling and provides a GUI offering +visual graph and tree representations to easily navigate generated profiling +information. + +If no arguments are provided, a window containing a list of running processes +is presented, allowing a process to be selected for profiling. + +Profiling information is written to `perfcore.<pid>` in the working directory +and opened immediately for browsing following termination of profiling. + +Profiler can also load performance information from previously created +`perfcore` files. + +## Options + +* `-p PID`, `--pid PID`: PID to profile + +## Examples + +Profile running Shell process: + +```sh +$ Profiler -p $(pidof Shell) +``` + +Open a previously created perfcore file for browsing: + +```sh +$ Profiler perfcore.123 +``` + +## See also + +* [`perfcore`(5)](../man5/perfcore.md) + |