Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 15 May 2018 13:21:16 -0400
From:      Jonathan Looney <jonlooney@gmail.com>
To:        rgrimes@freebsd.org
Cc:        araujo@freebsd.org, "Conrad E. Meyer" <cem@freebsd.org>,  src-committers <src-committers@freebsd.org>, svn-src-all@freebsd.org,  svn-src-head@freebsd.org
Subject:   Re: svn commit: r333494 - head/share/man/man7
Message-ID:  <CADrOrms%2B7gwbuTgn2LLff4qe%2BSo2qLB4JNFV7mB6rKyqamKHjQ@mail.gmail.com>
In-Reply-To: <201805140014.w4E0EeXt087837@pdx.rh.CN85.dnsmgr.net>
References:  <CAOfEmZg485aqHL=Yu1fNqcQ9FhZqN5JnEmrn48_H3cp5JEVnoA@mail.gmail.com> <201805140014.w4E0EeXt087837@pdx.rh.CN85.dnsmgr.net>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, May 13, 2018 at 8:14 PM, Rodney W. Grimes <
freebsd@pdx.rh.cn85.dnsmgr.net> wrote:
>
> It did take me some time to track down this "crazy concept you all
> think I just invented", but it is infact in the GNU groff info
> documentaton (found on my 5.4 systems in /usr/share/info/groff.info.gz):

Just to be clear, I don't think these rules apply to FreeBSD. We use
mandoc. See mandoc(1) for the rules that apply to us.

And, again, just to be clear, I am also pretty sure the following rule
doesn't apply:

>    * In keeping with this, it is helpful to begin a new line after every
>      comma or phrase, since common corrections are to add or delete
>      sentences or phrases.

OTOH, I believe we do have a rule about beginning each sentence on a new
line. (Again, see mandoc(1).)

And, it is easy to figure out whether your page complies with the style
using mandoc's checkers.

For example:

$ mandoc -W all,stop /usr/share/man/man9/tcp_functions.9.gz
mandoc: /usr/share/man/man9/tcp_functions.9.gz:284:16: WARNING: new
sentence, new line

Jonathan

PS: I'm happy to be corrected by one of the man page experts, which I most
certainly am not.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CADrOrms%2B7gwbuTgn2LLff4qe%2BSo2qLB4JNFV7mB6rKyqamKHjQ>