From f6457090af5f42a7d0f8e6291d35dc0eb463e4c4 Mon Sep 17 00:00:00 2001
From: Jaromil <jaromil@dyne.org>
Date: Mon, 11 Dec 2017 13:41:36 +0100
Subject: [PATCH] documentation of the new 'ps' command

---
 README.md  | 7 ++++---
 doc/tomb.1 | 8 ++++++++
 tomb       | 1 +
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b64a4fa..31606a6 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,7 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
    index   update the search indexes of tombs
    search  looks for filenames matching text patterns
    list    list of open TOMBs and information on them
+   ps      list of running processes inside open TOMBs
    close   close a specific TOMB (or 'all')
    slam    slam a TOMB killing all programs using it
    resize  resize a TOMB to a new size -s (can only grow)
@@ -95,10 +96,10 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
    -k     path to the key to be used ('-k -' to read from stdin)
    -n     don't process the hooks found in tomb
    -o     options passed to commands: open, lock, forge (see man)
-   -f     force operation (i.e. even if swap is active)
+   -f     force operation (i.e. open even if swap is active)
    -g     use a GnuPG key to encrypt a tomb key
-   -r     provide GnuPG recipients (separated by coma)
-   -R     provide GnuPG hidden recipients (separated by coma)
+   -r     provide GnuPG recipients (separated by comma)
+   -R     provide GnuPG hidden recipients (separated by comma)
    --kdf  forge keys armored against dictionary attacks
 
    -h     print this help
diff --git a/doc/tomb.1 b/doc/tomb.1
index f7f1b99..2d27b76 100644
--- a/doc/tomb.1
+++ b/doc/tomb.1
@@ -88,6 +88,14 @@ returns an error if it's not found. If the option
 \fI--get-mountpoint\fR is used then print a simple list of currently
 open tomb mountpoint paths.
 
+.B
+.IP "ps"
+List all the processes found running inside the tombs that are open,
+printing out their PIDs and owners. This is useful to have an overview
+of programs that are keeping the tombs busy and would eventually be
+killed by the \fIslam\fR command. The lsof(8) utility is used
+internally to enumerate processes running in one or all tombs.
+
 .B
 .IP "index"
 Creates or updates the search indexes of all tombs currently open:
diff --git a/tomb b/tomb
index 123c6ff..cd94be9 100755
--- a/tomb
+++ b/tomb
@@ -624,6 +624,7 @@ usage() {
     _print " index   update the search indexes of tombs"
     _print " search  looks for filenames matching text patterns"
     _print " list    list of open TOMBs and information on them"
+	_print " ps      list of running processes inside open TOMBs"
     _print " close   close a specific TOMB (or 'all')"
     _print " slam    slam a TOMB killing all programs using it"
     [[ $RESIZER == 1 ]] && {