summary refs log tree commit diff
path: root/catsit-timer.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--catsit-timer.162
1 files changed, 62 insertions, 0 deletions
diff --git a/catsit-timer.1 b/catsit-timer.1
new file mode 100644
index 0000000..9ad8956
--- /dev/null
+++ b/catsit-timer.1
@@ -0,0 +1,62 @@
+.Dd February 25, 2021
+.Dt CATSIT-TIMER 1
+.Os
+.
+.Sh NAME
+.Nm catsit-timer
+.Nd run command at interval
+.
+.Sh SYNOPSIS
+.Nm
+.Ar interval
+.Ar command ...
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility runs a command
+at an interval.
+The command is run once immediately,
+then again every
+.Ar interval
+after waiting for the command to exit
+each time.
+The
+.Nm
+utility is not appropriate
+for scheduling commands
+to run at specific times.
+.
+.Pp
+The format of the
+.Ar interval
+specifier is a series of integers
+followed by units:
+.Cm s
+for seconds,
+.Cm m
+for minutes
+and
+.Cm h
+for hours.
+An integer with no unit
+is assumed to be in seconds.
+The
+.Ar interval
+is the sum of each
+integer-unit pair.
+For example,
+.Cm 1m30s
+is equivalent to
+.Cm 90s .
+.
+.Sh EXIT STATUS
+If the command exits non-zero,
+.Nm
+exits with the same status.
+.
+.Sh SEE ALSO
+.Xr catsitd 8
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency