Re: [groff] groff as the basis for comprehensive documentation?

[Nate Bargmann]

* On 2018 21 Apr 02:07 -0500, G. Branden Robinson wrote:
> In my opinion, which I am far too young and poorly-connected to have
> proffered when it would have made any difference, the
> forced-full-capitalization of section titles in man page sources is an
> information-destroying transform done in the wrong place at the wrong
> time.  Section headings should be capitalized as section titles normally
> are in technical documentation: either like work titles, or first-letter
> only, with the normal rules for proper nouns and adjectives respected.

To be effective, I think one needs to get Michael Kerrisk of the
man-pages project https://www.kernel.org/doc/man-pages/ on board.  The
section heading examples in man-pages(7) are in all upper case.  I've
been using this page and others of the project along with groff_man(7)
as a guide for formatting my own pages.

> This has been itching me for many years; thanks for the excuse to air
> my grievance.  ;-)

Glad to start the thread that has led a number of different directions!
:-D

- Nate

-- 

"The optimist proclaims that we live in the best of all
possible worlds.  The pessimist fears this is true."

Web: http://www.n0nb.us  GPG key: D55A8819  GitHub: N0NB

signature.asc
Description: PGP signature