From 4ef5570c348e2d8d83c67e049b06e7b5d1a7542d Mon Sep 17 00:00:00 2001
From: Lukasz Kasprzak <lukas@labunix.xyz>
Date: Wed, 29 Jul 2026 08:24:34 +0200
Subject: feat(cli): --cal-dump NAME to generate a commented calendar template

Replace the static examples/sanctorale-of.ini with a `--cal-dump NAME` flag
that writes the running universal calendar to ~/.config/lectio/calendars/NAME.ini
as a fully-commented layer template (every celebration present, all commented).
Uncomment one day and edit a field to override it; enable with `use = NAME`.

- Form-aware: respects -l/--lectionary, so `-l trad --cal-dump x` dumps the 1962
  calendar (322 entries) and the default dumps the OF calendar (212 entries).
- Entries sorted by date then slug; refuses to overwrite an existing file.
- Always in sync with the embedded (or sanctorale-overridden) calendar, so no
  stale checked-in template to maintain.
- Update help text, man page (OPTIONS/FILES/EXAMPLES) and README to match;
  drop examples/sanctorale-of.ini.
---
 man/lectio.1 | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

(limited to 'man')

diff --git a/man/lectio.1 b/man/lectio.1
index 102e170..6ab8eb7 100644
--- a/man/lectio.1
+++ b/man/lectio.1
@@ -90,9 +90,19 @@ Print today's gospel reference and exit (for scripts and cron).
 List the coming week's gospel references and exit.
 .TP
 .B \-\-cal\-new \fINAME\fR
-Scaffold a custom calendar layer at
+Scaffold a small custom calendar layer at
 .IR ~/.config/lectio/calendars/NAME.ini .
 .TP
+.B \-\-cal\-dump \fINAME\fR
+Dump the whole universal calendar to
+.IR ~/.config/lectio/calendars/NAME.ini ,
+every celebration commented out. Uncomment one day and edit a field to override
+it. Respects
+.BR \-l / \-\-lectionary
+(dump the 1962 form with
+.BR "\-l trad" ).
+Refuses to overwrite an existing file.
+.TP
 .B \-\-cal\-check \fINAME\fR
 Validate a custom calendar layer and exit.
 .TP
@@ -136,10 +146,10 @@ Localised interface labels for \fBui_language = <code>\fR.
 .I ~/.config/lectio/calendars/
 Custom calendar layers, stacked over the universal calendar via
 .B use
-in config (field\-level add / override / suppress). A commented template of
-every universal celebration ships as
-.IR examples/sanctorale-of.ini :
-copy it here, then uncomment and edit a day to change it.
+in config (field\-level add / override / suppress). Generate a fully\-commented
+template of every universal celebration here with
+.BR "\-\-cal\-dump NAME" ,
+then uncomment and edit a day to change it.
 .TP
 .I ~/.config/lectio/sanctorale/of.ini
 .TQ
@@ -166,12 +176,12 @@ The year's key dates:
 .B lectio \-\-year 2026
 .RE
 .PP
-Change one day's celebration \(em copy the example layer, uncomment and edit the
+Change one day's celebration \(em dump the calendar, uncomment and edit the
 entry, enable it:
 .PP
 .RS
 .nf
-cp examples/sanctorale-of.ini ~/.config/lectio/calendars/mine.ini
+lectio \-\-cal\-dump mine
 $EDITOR ~/.config/lectio/calendars/mine.ini
 echo 'use = mine' >> ~/.config/lectio/config.ini
 .fi
-- 
cgit v1.3