aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-09-30 13:33:00 +0200
committerMattias Andrée <maandree@kth.se>2016-09-30 13:33:00 +0200
commit376542b13857db86dd5c36144f37bd58bd2646b8 (patch)
treeacbab319378f45c4502b1e1df3323a6619cb9190
parentAdd readme (diff)
downloadpdeath-376542b13857db86dd5c36144f37bd58bd2646b8.tar.gz
pdeath-376542b13857db86dd5c36144f37bd58bd2646b8.tar.bz2
pdeath-376542b13857db86dd5c36144f37bd58bd2646b8.tar.xz
Add manpage
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--Makefile5
-rw-r--r--doc/pdeath.134
2 files changed, 39 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index fc3e74c..255fc3c 100644
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,8 @@ PREFIX = /usr
BINDIR = $(PREFIX)/bin
DATADIR = $(PREFIX)/share
LICENSEDIR = $(DATADIR)/licences
+MANDIR = $(DATADIR)/man
+MAN1DIR = $(MANDIR)/man1
PKGNAME = pdeath
COMMAND = pdeath
@@ -23,9 +25,12 @@ install: bin/pdeath
cp -- bin/pdeath "$(DESTDIR)$(BINDIR)/$(COMMAND)"
mkdir -p -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)"
cp -- LICENSE "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE"
+ mkdir -p -- "$(DESTDIR)$(MAN1DIR)"
+ cp doc/pdeath.1 -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1"
uninstall:
-rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)"
+ -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1"
clean:
-rm -rf bin
diff --git a/doc/pdeath.1 b/doc/pdeath.1
new file mode 100644
index 0000000..b852635
--- /dev/null
+++ b/doc/pdeath.1
@@ -0,0 +1,34 @@
+.TH PDEATH 1 PDEATH
+.SH NAME
+pdeath \- Run a command that is killed when its parent exits
+.SH SYNOPSIS
+.B pdeath
+\fIsignal\fP[(\fB+\fP|\fB-\fP)\fIoff\fP]
+.I command
+.RI [ argument ]...
+.P
+.B pdeath
+.B -L
+.SH DESCRIPTION
+.B pdeath
+runs the select command with the parent death signal set to
+.I signal
+plus or minus
+.IR off .
+This means that the process receives this signal when its
+parent process dies.
+.SH OPTIONS
+.TP
+.B \-L
+List all signals.
+.SH LIMITATIONS
+.B pdeath
+cannot be used on binaries with set-user-ID or set-group-ID set.
+.SH AUTHORS
+Principal author, Mattias Andrée. See the LICENSE file for the full
+list of authors.
+.SH LICENSE
+ISC License.
+.SH BUGS
+Please report bugs to https://github.com/maandree/pdeath/issues or to
+maandree@kth.se