summary refs log tree commit diff
path: root/catsit-watch.1
diff options
context:
space:
mode:
Diffstat (limited to 'catsit-watch.1')
-rw-r--r--catsit-watch.152
1 files changed, 52 insertions, 0 deletions
diff --git a/catsit-watch.1 b/catsit-watch.1
new file mode 100644
index 0000000..b45f704
--- /dev/null
+++ b/catsit-watch.1
@@ -0,0 +1,52 @@
+.Dd February 25, 2021
+.Dt CATSIT-WATCH 1
+.Os
+.
+.Sh NAME
+.Nm catsit-watch
+.Nd run command when files are modified
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl i
+.Op Fl f Ar file
+.Ar command ...
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility runs a command
+each time any of a set of files
+are modified.
+If any watched files are removed
+or if the command exits non-zero,
+.Nm
+exits.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl f Ar file
+Add
+.Ar file
+to the set of watched files.
+.It Fl i
+Run the command once initially,
+before watching files.
+.El
+.
+.Sh EXIT STATUS
+If any watched files are removed,
+.Nm
+exits with
+.Dv EX_TEMPFAIL
+(75).
+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