mirror/groff
1
0
Fork 0
mirror of https://https.git.savannah.gnu.org/git/groff.git synced 2026-01-26 07:37:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

[man,mdoc]: Recommend ISO 8601 date format.

Browse Source 
* tmac/groff_man.7.man.in (Document structure macros):
* tmac/groff_mdoc.7.man (Title macros): Explicitly recommend ISO
  8601 date format.

Fixes <https://savannah.gnu.org/bugs/?66903>.  Thanks to Alex Colomar
for the suggestion.

Also recast man(7)'s `TH` macro description, mainly to solve the dual
knapsack problem imposed by seeking to preserve pleasant page breaks
when formatting PostScript and PDF for U.S. letter paper in both
groff_man(7) _and_ groff_man_style(7).
This commit is contained in:
G. Branden Robinson 2026-01-22 12:41:31 -06:00
parent c8b6ba92a1
commit eb5f3bc48b
3 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ChangeLog
View File

@ -1,3 +1,12 @@
2026-01-22 G. Branden Robinson <g.branden.robinson@gmail.com>
* tmac/groff_man.7.man.in (Document structure macros):
* tmac/groff_mdoc.7.man (Title macros): Explicitly recommend ISO
8601 date format.
Fixes <https://savannah.gnu.org/bugs/?66903>. Thanks to Alex
Colomar for the suggestion.
2026-01-21 G. Branden Robinson <g.branden.robinson@gmail.com> 2026-01-21 G. Branden Robinson <g.branden.robinson@gmail.com>
* Makefile.am: Add "filename-length-max=99" to * Makefile.am: Add "filename-length-max=99" to

34
tmac/groff_man.7.man.in
View File

@ -451,7 +451,12 @@ to inset a region within a (sub)section.
.RI [ footer-middle \~\c .RI [ footer-middle \~\c
.RI [ footer-inside \~\c .RI [ footer-inside \~\c
.RI [ header-middle ]]] .RI [ header-middle ]]]
Populate the page header and footer. Break the page,
reset the page number to\~1
(unless the
.B \-rC1
option is given),
and use the arguments to populate the page header and footer.
_ifstyle()dnl _ifstyle()dnl
. .
.I roff .I roff
@ -537,21 +542,13 @@ ellipses
.RB ( .\|.\|.\& ). .RB ( .\|.\|.\& ).
_endif()dnl _endif()dnl
. .
In HTML output, .I "groff man"
headers and footers are suppressed. suppresses headers and footers in HTML output.
. .
. .\" Does anyone try to do anything different? GBR hasn't seen it.
.IP .\" This feature is intended only for formatting multiple
Additionally, .\" .I man
this macro breaks the page, .\" documents in sequence.
resetting the number to\~1
(unless the
.B \-rC1
option is given).
.
This feature is intended only for formatting multiple
.I man
documents in sequence.
. .
. .
.IP .IP
@ -564,12 +561,11 @@ early in the file,
prior to any other macro calls. prior to any other macro calls.
_ifstyle()dnl _ifstyle()dnl
. .
.
.IP
By convention, By convention,
.I footer-middle .I footer-middle
is the date of the most recent modification to the man page source is the date of the most recent modification to the source document,
document, in ISO\~8601 format
.RI ( YYYY - MM - DD ),
and and
.I footer-inside .I footer-inside
is the name and version or release of the project providing it. is the name and version or release of the project providing it.

3
tmac/groff_mdoc.7.man
View File

@ -948,7 +948,8 @@ the four-digit year.
This localism is not enforced, This localism is not enforced,
however. however.
. .
You may prefer ISO 8601 format, .Xr groff
recommends ISO\~8601 format,
.Em YYYY-MM-DD. .Em YYYY-MM-DD.
. .
A A