documentation of the new 'ps' command

This commit is contained in:
Jaromil 2017-12-11 13:41:36 +01:00
parent 121a64bc80
commit f6457090af
3 changed files with 13 additions and 3 deletions

View File

@ -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 index update the search indexes of tombs
search looks for filenames matching text patterns search looks for filenames matching text patterns
list list of open TOMBs and information on them list list of open TOMBs and information on them
ps list of running processes inside open TOMBs
close close a specific TOMB (or 'all') close close a specific TOMB (or 'all')
slam slam a TOMB killing all programs using it slam slam a TOMB killing all programs using it
resize resize a TOMB to a new size -s (can only grow) 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) -k path to the key to be used ('-k -' to read from stdin)
-n don't process the hooks found in tomb -n don't process the hooks found in tomb
-o options passed to commands: open, lock, forge (see man) -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 -g use a GnuPG key to encrypt a tomb key
-r provide GnuPG recipients (separated by coma) -r provide GnuPG recipients (separated by comma)
-R provide GnuPG hidden recipients (separated by coma) -R provide GnuPG hidden recipients (separated by comma)
--kdf forge keys armored against dictionary attacks --kdf forge keys armored against dictionary attacks
-h print this help -h print this help

View File

@ -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 \fI--get-mountpoint\fR is used then print a simple list of currently
open tomb mountpoint paths. 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 .B
.IP "index" .IP "index"
Creates or updates the search indexes of all tombs currently open: Creates or updates the search indexes of all tombs currently open:

1
tomb
View File

@ -624,6 +624,7 @@ usage() {
_print " index update the search indexes of tombs" _print " index update the search indexes of tombs"
_print " search looks for filenames matching text patterns" _print " search looks for filenames matching text patterns"
_print " list list of open TOMBs and information on them" _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 " close close a specific TOMB (or 'all')"
_print " slam slam a TOMB killing all programs using it" _print " slam slam a TOMB killing all programs using it"
[[ $RESIZER == 1 ]] && { [[ $RESIZER == 1 ]] && {