Date: Sun, 19 Apr 2020 16:59:37 -0700 From: Conrad Meyer <cem@freebsd.org> To: Mateusz Piotrowski <0mp@freebsd.org> Cc: Yuri Pankov <ypankov@fastmail.com>, src-committers <src-committers@freebsd.org>, svn-src-all <svn-src-all@freebsd.org>, svn-src-head <svn-src-head@freebsd.org> Subject: Re: svn commit: r360078 - in head: sbin/bectl share/man/man8 Message-ID: <CAG6CVpVRXY==XHbo5TQNsA8NsgC4GgiWhPPQGsFKq8s8H8AuVg@mail.gmail.com> In-Reply-To: <35522470-1b08-0eaa-e12e-d0cbd6b652e9@FreeBSD.org> References: <202004181953.03IJrlA0090967@repo.freebsd.org> <530b4960-9735-15da-84b4-2fdda9930fc6@fastmail.com> <35522470-1b08-0eaa-e12e-d0cbd6b652e9@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
There is also mdoc(7), which describes the same thing:
SEE ALSO
References other manuals with related topics. This section should
exist for most manuals. Cross-references should conventionally be
ordered first by section, then alphabetically (ignoring case).
I consult mdoc(7) frequently when writing or editing manual pages.
In addition to 'mandoc -Tlint', there is a tool in ports called 'igor'
which can be used to perform some style checking of manual pages.
Hope that helps!
Regards,
Conrad
On Sun, Apr 19, 2020 at 3:36 AM Mateusz Piotrowski <0mp@freebsd.org> wrote:
>
> On 4/18/20 11:11 PM, Yuri Pankov wrote:
> > We don't have the man style guide (that I know of, at least)
> We have style.mdoc(5)!
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAG6CVpVRXY==XHbo5TQNsA8NsgC4GgiWhPPQGsFKq8s8H8AuVg>