summaryrefslogtreecommitdiff
path: root/Base/usr/share
diff options
context:
space:
mode:
authorBrendan Coles <bcoles@gmail.com>2021-02-23 12:44:41 +0000
committerAndreas Kling <kling@serenityos.org>2021-02-23 13:52:16 +0100
commit501834ba4542023fd63b1a14277b1870a4e73901 (patch)
tree4a6e1a9c1c53a8eda76ee8aa05b90ca16698396f /Base/usr/share
parent82278d632f4305da9867c37c2101bf99565e7172 (diff)
downloadserenity-501834ba4542023fd63b1a14277b1870a4e73901.zip
Inspector: Add help documentation
Diffstat (limited to 'Base/usr/share')
-rw-r--r--Base/usr/share/man/man1/Inspector.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/Inspector.md b/Base/usr/share/man/man1/Inspector.md
new file mode 100644
index 0000000000..f3166147d2
--- /dev/null
+++ b/Base/usr/share/man/man1/Inspector.md
@@ -0,0 +1,25 @@
+## Name
+
+Inspector - Serenity process inspector
+
+## Synopsis
+
+```**sh
+$ Inspector [pid]
+```
+
+## Description
+
+Inspector facilitates process inspection via RPC.
+
+The inspected process must have previously allowed the
+[`accept`(2)](../man2/accept.md) system call with
+[`pledge`(2)](../man2/pledge.md) to allow inspection
+via UNIX socket.
+
+## Examples
+
+```sh
+$ Inspector $(pidof Shell)
+```
+