minor: documentation
authorIan Kelling <iank@fsf.org>
Fri, 13 Jan 2023 23:07:26 +0000 (18:07 -0500)
committerIan Kelling <iank@fsf.org>
Fri, 13 Jan 2023 23:07:26 +0000 (18:07 -0500)
sysd-mail-once

index b1a67b881cee88388d64ff0e31cda81d24de96f7..d44b77fd48f35c0405be838fc20052b99604ae6f 100755 (executable)
@@ -23,8 +23,10 @@ to=root
 case "$1" in
   -h|--help)
     cat <<EOF
-Usage: sysd-mail-once [-t TO_ADDRESS] [-ERRORS] SERVICE COMMAND [ARGS...]
-For systemd timers, email (with exim) on repeated failure & success after failure.
+Usage: sysd-mail-once [-t TO_ADDRESS] [-ERRORS] SERVICE COMMAND [COMMAND_ARGS...]
+
+For use with systemd timers, to email (with exim) on repeated failure &
+success after failure.
 
 In the service triggered by the timer, prepend this script to the ExecStart.
 The email will contain the service's logs for the last ERRORS runs.
@@ -34,6 +36,8 @@ Stores error counts in $cbase
 
 -ERRORS:  ERRORS is the number of failurs to accumulate before mailing the error.
           Default is 3.
+
+-t TO_ADDRESS:  Address to email about errors
 EOF
     exit 0
     ;;