Hello, The vast majority of manpages uses the following order in their prologue: .Dd/Dt/Os And groff_mdoc(7) is setting a bad example here, the attached patch fixes this.
It also makes the use of .Pp inside .Bl more consistent throughout the page (ie., no .Pp inside .Bl, not required unless using -compact anyway) And also removes mis-use of -indent which is not a flag but usually used literally. Also, the list of NetBSD, FreeBSD and DragonflyBSD releases was updated. The indention should reflect the longest entry, so I fixed that as well. Btw, why are the OpenBSD releases not listed? Regards, Uli
Index: tmac/groff_mdoc.man =================================================================== RCS file: /sources/groff/groff/tmac/groff_mdoc.man,v retrieving revision 1.51 diff -u -p -r1.51 groff_mdoc.man --- tmac/groff_mdoc.man 4 Jun 2010 13:08:12 -0000 1.51 +++ tmac/groff_mdoc.man 21 Oct 2010 19:30:38 -0000 @@ -44,9 +44,9 @@ .\" for an already extremely slow package. .\" . -.Dd June 04, 2010 -.Os +.Dd October 21, 2010 .Dt GROFF_MDOC 7 +.Os . . .Sh NAME @@ -563,8 +563,8 @@ The body of a man page is easily constru .Bd -literal -offset indent \&.\e" The following commands are required for all man pages. \&.Dd Month day, year -\&.Os [OPERATING_SYSTEM] [version/release] \&.Dt DOCUMENT_TITLE [section number] [architecture/volume] +\&.Os [OPERATING_SYSTEM] [version/release] \&.Sh NAME \&.Nm name \&.Nd one line description of name @@ -600,9 +600,9 @@ The body of a man page is easily constru . The first items in the template are the commands .Ql .Dd , -.Ql .Os , +.Ql .Dt , and -.Ql .Dt ; +.Ql .Os ; the document date, the operating system the man page or subject source is developed or modified for, and the man page title (in .Em upper case ) @@ -856,7 +856,7 @@ is the acronym for the operating system the release ID. . .Bd -ragged -compact -.Bl -tag -width ".No FreeBSD" -offset indent +.Bl -tag -width ".No DragonFly" -offset indent .It ATT 7th, 7, III, 3, V, V.2, V.3, V.4 .It BSD @@ -865,14 +865,16 @@ the release ID. 0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.4.1, 1.4.2, 1.4.3, 1.5, 1.5.1, 1.5.2, 1.5.3, 1.6, 1.6.1, 1.6.2, 1.6.3, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 3.0, 3.0.1, 3.0.2, 3.1, 4.0, -4.0.1 +4.0.1, 5.0, 5.0.1, 5.0.2 .It FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, 4.8, 4.9, 4.10, 4.11, 5.0, 5.1, -5.2, 5.2.1, 5.3, 5.4, 5.5, 6.0, 6.1, 6.2, 6.3, 6.4, 7.0, 7.1, 7.2, 7.3, 8.0 +5.2, 5.2.1, 5.3, 5.4, 5.5, 6.0, 6.1, 6.2, 6.3, 6.4, 7.0, 7.1, 7.2, 7.3, 8.0, +8.1 .It DragonFly -1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.8, 1.8.1, 1.10, 1.12, 1.12.2, 2.0 +1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.8, 1.8.1, 1.10, 1.12, 1.12.2, 2.0, 2.2, +2.4, 2.6 .It Darwin 8.0.0, 8.1.0, 8.2.0, 8.3.0, 8.4.0, 8.5.0, 8.6.0, 8.7.0, 8.8.0, 8.9.0, 8.10.0, 8.11.0, 9.0.0, 9.1.0, 9.2.0, 9.3.0, 9.4.0, 9.5.0, 9.6.0 @@ -1588,7 +1590,7 @@ For example, .Ql ".Rv \-std atexit" produces: . -.Bd -ragged -offset -indent +.Bd -ragged -offset indent \# a small hack to suppress a warning message .ds section-old "\*[section] .ds section 3 @@ -1618,7 +1620,7 @@ For example, .Ql ".Ex \-std cat" produces: . -.Bd -ragged -offset -indent +.Bd -ragged -offset indent \# a small hack to suppress a warning message .ds section-old "\*[section] .ds section 1 @@ -2000,8 +2002,8 @@ Part 2: Shell and Utilities .Pp . X/Open -.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent .Pp +.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent .It Li \-susv2 .St -susv2 .It Li \-susv3
_______________________________________________ bug-groff mailing list [email protected] http://lists.gnu.org/mailman/listinfo/bug-groff
