aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-08-18 13:20:50 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-08-18 13:20:50 +0200
commite48fa4a2d315ac2b3832611ff48ed2e986e7b49e (patch)
tree95d0a76818140d833577a46bf778b1e92822abcb /man
parent084ff22997af208715656924d9fc23bf2ec10050 (diff)
parent49494c3aedf3f1b40c6ee36cb4de5615f097274c (diff)
downloadcolitur-e48fa4a2d315ac2b3832611ff48ed2e986e7b49e.tar.gz
colitur-e48fa4a2d315ac2b3832611ff48ed2e986e7b49e.zip
merge: overlay authoring ergonomics
Two mandatory fields made optional, parse errors that stop naming kernel source files, and a feedback loop -- colitur check and colitur new-overlay -- for a file the test layers deliberately cannot vouch for.
Diffstat (limited to 'man')
-rw-r--r--man/colitur.121
1 files changed, 21 insertions, 0 deletions
diff --git a/man/colitur.1 b/man/colitur.1
index 8a52858..a637f19 100644
--- a/man/colitur.1
+++ b/man/colitur.1
@@ -65,6 +65,27 @@ occurrence, commemoration and transfer.
.BI readings " YEAR"
The Mass reading citations, one line per day.
.TP
+.B new\-overlay
+Print a starter overlay file to standard output, for redirection. Every value
+in it is a placeholder that will appear in
+.B day
+output if left unedited, so a half\-finished overlay is visible rather than
+silently inert.
+.TP
+.BI check " FILE" ...
+Load each overlay, apply it to the shipped calendar, and report what it does:
+the directive counts, the slug each targets, and any directive that matched
+nothing. Exits
+.B 2
+if a file fails to load or a directive found no target, so it composes into a
+Makefile or a pre\-commit hook. It answers three narrow questions \(em does
+the file parse, does every directive find its target, and what does the merged
+result contain. It does
+.I not
+validate a calendar against the rubrics, and cannot: see
+.B OVERLAYS
+below.
+.TP
.BI \-\-overlay " FILE"
Apply a user calendar on top of the shipped one. Repeatable and ordered;
.B day