diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/colitur.1 | 138 |
1 files changed, 130 insertions, 8 deletions
diff --git a/man/colitur.1 b/man/colitur.1 index 4a3c580..3f485d5 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,18 @@ occurrence, commemoration and transfer. .BI readings " YEAR" The Mass reading citations, one line per day. .TP +.BI rubrics " YEAR" +Four rubrics of the Mass, one line per day: which formulary is actually +said \(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 \(em whether the Creed is said (RG 475\-476), +whether the Gloria in excelsis is said (RG 431\-432, deferring to the +Breviary's own Te Deum rule, nn. 237\-238, for RG 431(a)), and which +preface is said (RG 482\-499). 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 +227,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 +459,110 @@ 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 [TAB] creed [TAB] gloria [TAB] preface +.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), followed by whether the Creed is said (RG 475\-476), +whether the Gloria in excelsis is said (RG 431\-432), and which preface is +said (RG 482\-499). +.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 either of these) 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 . +.I creed +and +.I gloria +are each +.B true +or +.B false +(OCaml's own literal, not +.RB \(lq yes / no \(rq +or +.RB \(lq 1/0 \(rq : +this row has no other boolean field to be consistent with). A day with no +Mass at all for a rite that has not implemented a rule reads +.B false +outright \(em it is a decision, never a third \(lqunknown\(rq state. +.I preface +is one of +.BR nativity ", " epiphany ", " lent ", " holy\-cross ", " easter ", " +.BR ascension ", " sacred\-heart ", " christ\-the\-king ", " holy\-spirit ", " +.BR trinity ", " bvm ", " st\-joseph ", " apostles ", " common " or " requiem , +or a literal +.B \- +when this engine resolves no Mass at all that day (Good Friday) \(em unlike +.I creed / gloria , +.I preface +is a genuine option, so +.B \- +here can also mean a rite that has not implemented the rule at all. +.RS +.nf + +2026\-01\-01 [TAB] ef\-circumcision [TAB] own [TAB] true [TAB] true [TAB] nativity +2038\-03\-08 [TAB] john\-of\-god [TAB] proper [TAB] false [TAB] true [TAB] common +2025\-12\-01 [TAB] ef\-advent\-sunday\-1 [TAB] preceding\-sunday [TAB] false [TAB] false [TAB] common +.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 +1013,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 @@ -911,7 +1021,7 @@ rather than silently ignored. .PP .B An overlay is applied, not validated. This program's test layers \(em properties over every year in the domain, a -differential against a sibling engine, two published\-calendar oracles, and +differential against a sibling engine, three published\-calendar oracles, and hand\-verified pins \(em assert things about the .I shipped calendar. None of them can vouch for a file you supply. A directive naming a @@ -1477,6 +1587,18 @@ emits. Published calendars \(em missalemeum, Divinum Officium, gcatholic \(em are used as comparison oracles in the test suite only: a divergence from one is flagged loudly and adjudicated against the Missal, never silently adopted. Several such divergences have been resolved in this engine's favour. +Missalemeum's own data derives from Divinum Officium, so those two are one +lineage rather than two independent witnesses; a printed +.I Ordo +from the Latin Mass Society of England and Wales, compiled directly from the +Missal and never passed through that lineage, is used as a genuinely +independent oracle for one liturgical year (Advent 2024 through the end of +1962's 2025) \(em the Creed rubric, the Saturday votive Mass of Our Lady's +own seasonal selection, and which Mass a day borrows, each compared against +it in full. It covers only the universal calendar (its own diocesan propers +and local patrons are excluded from every comparison), one civil year, and +one publisher's transcription \(em a divergence against it is a question, +not a verdict, the same discipline applied to every other oracle here. .SH LIMITATIONS Only the Extraordinary Form (1962) is implemented; the Ordinary Form is a planned peer module, not an overlay of this one. |
