aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-30 10:11:55 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-30 10:11:55 +0100
commit01bdcb481cd086a3fe491ed1b51f9f817b09ad5e (patch)
tree81dd76e2ed4275eb3097f30567518b978404ca21
parentimprove readme (diff)
downloadorphan-reaper-01bdcb481cd086a3fe491ed1b51f9f817b09ad5e.tar.gz
orphan-reaper-01bdcb481cd086a3fe491ed1b51f9f817b09ad5e.tar.bz2
orphan-reaper-01bdcb481cd086a3fe491ed1b51f9f817b09ad5e.tar.xz
m + add man page
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--COPYING2
-rw-r--r--README4
-rw-r--r--doc/man/orphan-reaper.143
3 files changed, 46 insertions, 3 deletions
diff --git a/COPYING b/COPYING
index 5bf0c0e..dfce358 100644
--- a/COPYING
+++ b/COPYING
@@ -1,5 +1,5 @@
orphan-reaper — Place subreapers in your process tree to keep it structured
-Copyright © 2014 Mattias Andrée (maandree@member.fsf.org)
+Copyright © 2014, 2015 Mattias Andrée (maandree@member.fsf.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
diff --git a/README b/README
index 38fc05d..6a4985a 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
NAME
- orphan-reaper - Keep your process tree clean.
+ orphan-reaper - Keep your process tree clean
SYNOPSIS
orphan-reaper [--fatal] [--] COMMAND...
@@ -25,5 +25,5 @@ RATIONALE
Especially when multiple display servers are running.
SEE ALSO
- prctl(2)
+ prctl(2), pstree(1), htop(1)
diff --git a/doc/man/orphan-reaper.1 b/doc/man/orphan-reaper.1
new file mode 100644
index 0000000..f1b05e7
--- /dev/null
+++ b/doc/man/orphan-reaper.1
@@ -0,0 +1,43 @@
+.TH ORPHAN-REAPER 1 ORPHAN-REAPER
+.SH NAME
+orphan-reaper - Keep your process tree clean
+.SH SYNOPSIS
+.BR orphan-reaper
+[--fatal] [--]
+.IR COMMAND ...
+.SH 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.
+.SH OPTIONS
+.TP
+.BR \-\-fatal
+Fail if the process cannot become a subreaper.
+.SH 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.
+.SH "SEE ALSO"
+.BR prctl (2),
+.BR pstree (1),
+.BR htop (1)
+.SH AUTHORS
+Principal author, Mattias Andrée. See the COPYING file for the full
+list of authors.
+.SH LICENSE
+Copyright \(co 2014, 2015 Mattias Andrée
+.br
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+.br
+There is NO WARRANTY, to the extent permitted by law.
+.SH BUGS
+Please report bugs to https://github.com/maandree/orphan-reaper/issues or to
+maandree@member.fsf.org