diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/colitur.1 | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/man/colitur.1 b/man/colitur.1 index 1a330d8..55383ec 100644 --- a/man/colitur.1 +++ b/man/colitur.1 @@ -476,6 +476,40 @@ Print a usage summary to standard output and exit 0. .TP .BR \-V ", " \-\-version Print the version and exit 0. +.SH PRETTY OUTPUT +.B \-\-pretty +lays the rows out for a terminal rather than for +.BR awk (1): +aligned columns, the day's liturgical colour as a filled circle, and +commemorations on their own indented line instead of lengthening the row. +.PP +Accepted by +.BR day ", " readings ", " rubrics " and " temporal . +Every other command refuses it rather than accepting it and doing nothing: +.BR emit ", " table ", " render " and " publish +already choose their shape through +.B \-\-format +or +.BR \-\-template , +and +.B easter +prints six key/value lines rather than a day grid. +.PP +Colour is written only when standard output is a terminal, so redirecting or +piping yields plain aligned text \-\- the alignment survives, the escape +sequences do not, and the colour column degrades to its initial +.RB ( w ", " r ", " g ", " v ", " o ", " k ) +so the information is not simply lost. The +.B NO_COLOR +environment variable is honoured on presence, whatever its value, per the +convention at https://no-color.org. +.PP +The default output is unchanged by this flag and remains the parseable one. +Nothing should be written to parse +.BR \-\-pretty : +its layout is free to change, which is precisely what the default format is +not. +.PP .SH OUTPUT FORMAT .SS day .RS |