From 6fb08baee3602fc28c323a8eced868fd49050d7f Mon Sep 17 00:00:00 2001
From: "C. McEnroe" <june@causal.agency>
Date: Sat, 15 Aug 2020 16:40:15 -0400
Subject: Rename project to catsit

---
 catsit.8 | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 catsit.8

(limited to 'catsit.8')

diff --git a/catsit.8 b/catsit.8
new file mode 100644
index 0000000..d901359
--- /dev/null
+++ b/catsit.8
@@ -0,0 +1,97 @@
+.Dd August 15, 2020
+.Dt CATSIT 8
+.Os
+.
+.Sh NAME
+.Nm catsit
+.Nd catsitd control
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar control
+.Cm start|stop|restart|status Ns | Ns Ar signal
+.Ar service ...
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility controls
+the services managed by the
+.Xr catsitd 8
+daemon.
+It does so by writing
+the remainder of its command line
+to a named pipe.
+.
+.Pp
+Communication with
+.Xr catsitd 8
+is unidirectional.
+The daemon logs any feedback
+with syslog.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl c Ar control
+Set the path of the named pipe.
+.
+.It Cm start
+Start any matching services
+which are not already started.
+.
+.It Cm stop
+Stop any matching services
+which are not already stopped.
+Processes are stopped using the
+.Dv TERM
+signal.
+.
+.It Cm restart
+Restart any matching services.
+Started services will first be stopped,
+then stopped services will be started.
+.
+.It Cm status
+Log the current status of any matching services.
+.
+.It Ar signal
+Send the named signal
+to the processes of any matching started services.
+.
+.It Ar service ...
+The list of services to operate on.
+Service names can include
+the shell-style pattern operators
+.Sy *?[] .
+Be sure to quote service name patterns
+so they are not interpreted by the shell.
+.El
+.
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev CATSITD_PIPE
+The path of the named pipe.
+The
+.Fl c
+flag overrides this variable.
+.El
+.
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa /var/run/catsitd.pipe
+The default path of the named pipe.
+.El
+.
+.Sh EXAMPLES
+.Bd -literal
+catsit start pounce/freenode
+catsit status '*'
+catsit USR1 'pounce/*'
+.Ed
+.
+.Sh SEE ALSO
+.Xr catsitd 8
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency
-- 
cgit 1.4.1