aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-30 09:27:55 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-30 09:28:17 +0100
commitafc2c86548950f98ab5cc2e4c3f9de39b6cb9b89 (patch)
tree1edbe0341441b8848bdc1a48ac27d4715e108b61
parenttypo (diff)
downloadorphan-reaper-afc2c86548950f98ab5cc2e4c3f9de39b6cb9b89.tar.gz
orphan-reaper-afc2c86548950f98ab5cc2e4c3f9de39b6cb9b89.tar.bz2
orphan-reaper-afc2c86548950f98ab5cc2e4c3f9de39b6cb9b89.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README36
1 files changed, 28 insertions, 8 deletions
diff --git a/README b/README
index bf7f302..38fc05d 100644
--- a/README
+++ b/README
@@ -1,9 +1,29 @@
-This daemon spawns a process and reaps all orphaned
-grandchildren. This is useful if you want to keep
-your process tree clean. For instance if you want
-all programs started from inside the same display
-server instance to appear to be inside that display
-if you look inside the process tree, rather than all
-processes that loses their parent being reparented
-to PID 1 and make a mess on your process tree.
+NAME
+ orphan-reaper - Keep your process tree clean.
+
+SYNOPSIS
+ orphan-reaper [--fatal] [--] COMMAND...
+
+DESCRIPTION
+ This user daemon spawns a process and reaps all orphaned
+ grandchildren. This is useful if you want to keep your
+ process tree clean. For instance if you want all programs
+ started from inside the same display server instance to
+ appear to be inside that display if you look inside the
+ process tree, rather than all processes that loses their
+ parent being reparented to PID 1 and make a mess on your
+ process tree.
+
+OPTIONS
+ --fatal
+ Fail if the process cannot become a subreaper.
+
+RATIONALE
+ It is really nice to have a processes that are running
+ inside a display server to be a grandchild of the
+ display server, rather than being reparanted to PID 1.
+ Especially when multiple display servers are running.
+
+SEE ALSO
+ prctl(2)