115 lines
2.0 KiB
Groff
115 lines
2.0 KiB
Groff
.Dd August 16, 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|drop 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.
|
|
Services scheduled for automatic restart
|
|
are started immediately
|
|
but their restart intervals are not reset.
|
|
.
|
|
.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 be stopped
|
|
and started again.
|
|
Stopped services will be started.
|
|
Services scheduled for automatic restart
|
|
will be started immediately
|
|
and their restart intervals will be reset.
|
|
.
|
|
.It Cm status
|
|
Log the current status of any matching services.
|
|
.
|
|
.It Cm drop
|
|
Drop any matching stopped services
|
|
from the services list.
|
|
.
|
|
.It Ar signal
|
|
Send the named signal
|
|
to the processes of any matching started services.
|
|
Signal names are case-insensitive.
|
|
.
|
|
.It Ar service ...
|
|
The list of services to operate on.
|
|
Service names can include
|
|
.Sy *?[]
|
|
shell-style pattern operators.
|
|
Patterns must be quoted
|
|
to be interpreted by
|
|
.Xr catsitd 8
|
|
rather than the shell.
|
|
Each service name pattern
|
|
is operated on in order,
|
|
but services matched by each pattern
|
|
are in unspecified order.
|
|
.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 restart pounce/freenode
|
|
catsit INFO 'pounce/*'
|
|
.Ed
|
|
.
|
|
.Sh SEE ALSO
|
|
.Xr catsitd 8
|
|
.
|
|
.Sh AUTHORS
|
|
.An June Bug Aq Mt june@causal.agency
|