summary refs log tree commit diff
path: root/catsit.8
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-08-17 01:11:44 -0400
committerJune McEnroe <june@causal.agency>2020-08-17 01:11:44 -0400
commit84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03 (patch)
treecc438def4a5354e2d22ec1ac9f61387959956f43 /catsit.8
parentAdd drop command (diff)
downloadcatsit-84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03.tar.gz
catsit-84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03.zip
Flesh out documentation and improve examples
Diffstat (limited to '')
-rw-r--r--catsit.831
1 files changed, 22 insertions, 9 deletions
diff --git a/catsit.8 b/catsit.8
index ae4de38..7448012 100644
--- a/catsit.8
+++ b/catsit.8
@@ -39,6 +39,9 @@ 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
@@ -49,8 +52,12 @@ signal.
 .
 .It Cm restart
 Restart any matching services.
-Started services will first be stopped,
-then stopped services will be started.
+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.
@@ -62,14 +69,21 @@ 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
-the shell-style pattern operators
-.Sy *?[] .
-Be sure to quote service name patterns
-so they are not interpreted by the shell.
+.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
@@ -89,9 +103,8 @@ The default path of the named pipe.
 .
 .Sh EXAMPLES
 .Bd -literal
-catsit start pounce/freenode
-catsit status '*'
-catsit USR1 'pounce/*'
+catsit restart pounce/freenode
+catsit INFO 'pounce/*'
 .Ed
 .
 .Sh SEE ALSO