summary refs log tree commit diff
diff options
context:
space:
mode:
authorC. McEnroe <june@causal.agency>2020-08-13 20:35:14 -0400
committerC. McEnroe <june@causal.agency>2020-08-14 16:00:34 -0400
commit021003a3e079365cf1f4fe0c52137967c7597b57 (patch)
treebfd92e32d3aa83de8645f94c22053daa2fbbbbe8
parentAdd prospective manual page for spawnd (diff)
downloadcatsit-021003a3e079365cf1f4fe0c52137967c7597b57.tar.gz
catsit-021003a3e079365cf1f4fe0c52137967c7597b57.zip
Add prospective manual page for spawn
-rw-r--r--spawn.897
1 files changed, 97 insertions, 0 deletions
diff --git a/spawn.8 b/spawn.8
new file mode 100644
index 0000000..f5ecc6c
--- /dev/null
+++ b/spawn.8
@@ -0,0 +1,97 @@
+.Dd August 13, 2020
+.Dt SPAWN 8
+.Os
+.
+.Sh NAME
+.Nm spawn
+.Nd spawnd 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 spawnd 8
+daemon.
+It does so by writing
+the remainder of its command line
+to a named pipe.
+.
+.Pp
+Communication with
+.Xr spawnd 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 SPAWND_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/spawnd.pipe
+The default path of the named pipe.
+.El
+.
+.Sh EXAMPLES
+.Bd -literal
+spawn start pounce/freenode
+spawn status '*'
+spawn USR1 'pounce/*'
+.Ed
+.
+.Sh SEE ALSO
+.Xr spawnd 8
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency