commit 597db7b4a0ec2805d49519b2dc85727592db09ed
parent 85151b8208f9da4ada5a123919b3856cee39360b
Author: Cem Keylan <cem@ckyln.com>
Date: Fri, 28 Feb 2020 15:58:33 +0300
add manpages
Diffstat:
3 files changed, 50 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -8,6 +8,8 @@ LINK = runsyssv svctl
install:
install -Dm755 sysmgr ${DESTDIR}${BINDIR}/sysmgr
for link in ${LINK} ; do ln -sf sysmgr ${DESTDIR}${BINDIR}/$$link ; done
+ install -Dm644 -t ${DESTDIR}${MANPREFIX}/man1 svctl.1
+ install -Dm644 -t ${DESTDIR}${MANPREFIX}/man8 sysmgr.8
uninstall:
rm -rf ${DESTDIR}${BINDIR}/sysmgr
diff --git a/svctl.1 b/svctl.1
@@ -0,0 +1,29 @@
+.
+.TH "SVCTL" "1" "February 2020" "Cem Keylan" "General Commands Manual"
+.
+.SH "NAME"
+\fBsvctl\fR \- sysmgr service controller
+.
+.SH "SYNOPSIS"
+svctl \fI<command>\fR \fI<service>\fR
+.
+.P
+runs the given command against the sysmgr service\.
+.
+.SH "COMMANDS"
+start/stop/restart \-\- Starts/stops/restarts a service
+.
+.P
+kill \-\- Sends a SIGKILL to the service
+.
+.P
+once \-\- Starts a service and does not restart it if it goes down\.
+.
+.P
+status \-\- Check if the service is running or not\.
+.
+.P
+up/down \-\- Same as start/stop
+.
+.SH "AUTHOR"
+Cem Keylan
diff --git a/sysmgr.8 b/sysmgr.8
@@ -0,0 +1,19 @@
+.
+.TH "SYSMGR" "8" "February 2020" "sysmgr" "System Manager's Manual"
+.
+.SH NAME
+\fBsysmgr\fR \-\- a UNIX system-supervisor
+.
+.SH DESCRIPTION
+sysmgr is a system-supervisor written in POSIX-sh. Its' configuration
+is rather simple. It can take \fBRUNDIR\fR and \fBSYSDIR\fR as environment
+variables, which default to \fI/run/sysmgr\fR and \fI/var/sysmgr\fR
+respectively.
+.
+.SH SERVICE SCRIPTS
+sysmgr service scripts can be as simple as a one-line command. Make
+sure that the service command stays on the foreground and are not
+daemonized.
+.
+.SH AUTHOR
+Cem Keylan <cem@ckyln.com>