aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/colitur.191
1 files changed, 84 insertions, 7 deletions
diff --git a/man/colitur.1 b/man/colitur.1
index 4a3c580..5a8ebbf 100644
--- a/man/colitur.1
+++ b/man/colitur.1
@@ -3,7 +3,7 @@
colitur \- deterministic liturgical calendar and lectionary engine (Roman rite, 1962)
.SH SYNOPSIS
.B colitur
-.BR easter | temporal | day | readings
+.BR easter | temporal | day | readings | rubrics
.I YEAR
.br
.B colitur
@@ -17,6 +17,11 @@ colitur \- deterministic liturgical calendar and lectionary engine (Roman rite,
.RB [ \-\-raw ]
.br
.B colitur
+.B rubrics
+.I YEAR
+.RB [ \-\-overlay " FILE" " ...]"
+.br
+.B colitur
.B emit
.BI \-\-format " FMT"
.BI \-\-from " YEAR"
@@ -116,6 +121,15 @@ occurrence, commemoration and transfer.
.BI readings " YEAR"
The Mass reading citations, one line per day.
.TP
+.BI rubrics " YEAR"
+The Mass formulary actually said, one line per day \(em not always the
+day's own: a weekday with no proper resumes the preceding Sunday's, a
+saint with no proper says his assigned Common, and RG 78/309(a)'s votive
+Saturday Mass of Our Lady is said in place of an unoccupied office's own.
+See
+.B OUTPUT FORMAT
+below.
+.TP
.B emit
Render a civil\-year range through one of five emitters \(em
.BR csv ", " json ", " sexp ", " xml " or " ics .
@@ -210,7 +224,7 @@ for the config file's location and precedence in full.
.TP
.BI \-\-overlay " FILE"
Apply a user calendar on top of the shipped one. Repeatable and ordered;
-.BR day ", " readings ", " emit ", " table ", " render " and " publish
+.BR day ", " readings ", " rubrics ", " emit ", " table ", " render " and " publish
only. See
.B OVERLAYS
below.
@@ -442,17 +456,80 @@ own trailing field, above.
2038\-03\-06 sts\-felicitas\-perpetua | Ecclus 51:1\-8, 12 | Matt 13:44\-52 | Ss. Perpetuae et Felicitatis Mm.
.fi
.RE
+.SS rubrics
+.RS
+.nf
+date [TAB] formulary\-slug [TAB] source
+.fi
+.RE
.PP
-Both reports are one line per day and ordered by date, so they compose with
+The day's own Mass formulary: which slug's Mass is actually said, and how
+that was decided.
+.B rubrics
+separates its fields with a literal TAB \(em not a plain space like
+.B day
+or
+.RB \(lq " | " \(rq
+like
+.B readings
+\(em because a resolved formulary NAME (a column a later version may add,
+not this one) can carry both spaces and punctuation a citation never does,
+which rules out either separator already in use above. A separate command
+for the identical mechanical reason
+.B day
+is separate from
+.BR readings :
+.BR day 's
+own row is fixed\-width space\-separated with a variable\-length
+.RI + slug
+tail, so appending anything with its own internal whitespace there would
+leave it unsplittable by field number.
+.I source
+is one of
+.BR proper ", " own ", " preceding\-sunday ", " common " or " votive .
+.RS
+.nf
+
+2026\-01\-01 [TAB] ef\-circumcision [TAB] own
+2038\-03\-08 [TAB] john\-of\-god [TAB] proper
+2025\-12\-01 [TAB] ef\-advent\-sunday\-1 [TAB] preceding\-sunday
+.fi
+.RE
+.PP
+Unlike
+.B day
+and
+.BR readings ,
+.B rubrics
+resolves no display name and no citation, so it takes none of
+.BR \-\-lang ", " \-\-raw
+or any
+.B \-\-sigla\-*
+flag \(em refused rather than silently ignored, the same discipline
+.B \-\-overlay
+gets on
+.B easter
+and
+.BR temporal .
+.PP
+All three reports are one line per day and ordered by date, so they compose
+with
.BR grep (1),
.BR awk (1)
and
.BR join (1)
in the ordinary way. Pass
.B \-\-raw
-to restore the pre\-naming byte\-exact output of either report \(em no
-trailing field at all \(em for a script written against it before this
-feature existed.
+to restore the pre\-naming byte\-exact output of
+.B day
+or
+.B readings
+\(em no trailing field at all \(em for a script written against either
+before the naming feature existed;
+.B rubrics
+is already in that form and has no
+.B \-\-raw
+of its own to pass.
.SH EMIT
.BI "colitur emit " \-\-format " FMT " \-\-from " YEAR " \-\-to " YEAR"
renders the same resolved day \(em season, week, slug, rank, colour,
@@ -903,7 +980,7 @@ shapes:
.RE
.PP
Accepted on
-.BR day ", " readings ", " emit ", " table ", " render " and " publish .
+.BR day ", " readings ", " rubrics ", " emit ", " table ", " render " and " publish .
.BR easter " and " temporal
read no sanctoral data at all, so the flag would have no effect there and is
.I refused