commit: f9874df533be83ebb2f05e30b7ce3be608bf25f1
parent c527057fb387e101c5d9788a3dd6d162d823efe5
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Wed, 18 Jun 2025 12:37:17 +0200
README.md: Add
Diffstat:
1 file changed, 22 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# timer - run command at a specific interval
+```
+SPDX-FileCopyrightText: 2025 Haelwenn (lanodan) Monnier <contact+cmd-timer@hacktivis.me>
+SPDX-License-Identifier: MIT
+```
+
+The `timer` utility runs `command [arguments...]` at every `interval`.
+
+`interval` is a string containing numbers, terminated by suffixes:
+`s` for seconds, `m` for minutes, `h` for hours, `d` for days.
+
+If the final number doesn't have a suffix, seconds are assumed.
+Longer durations are taken as out of scope.
+
+## Examples
+
+* Run `munin-cron` every 5 minutes: ``timer 5m munin-cron``
+* Print bell every minute and a half: ``timer 1m30s printf '\a'``
+
+## See Also
+
+- [snooze](https://github.com/leahneukirchen/snooze): Similar utility albeit more complex, and execs into the program instead of spawning it into a new process
