From owner-freebsd-doc  Mon Feb  5  0:55:48 2001
Delivered-To: freebsd-doc@freebsd.org
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP
	id 1200937B6B0; Mon,  5 Feb 2001 00:55:26 -0800 (PST)
Received: (from jkoshy@localhost)
	by freefall.freebsd.org (8.11.1/8.11.1) id f158tPR59392;
	Mon, 5 Feb 2001 00:55:25 -0800 (PST)
	(envelope-from jkoshy)
Date: Mon, 5 Feb 2001 00:55:25 -0800 (PST)
From: <jkoshy@FreeBSD.org>
Message-Id: <200102050855.f158tPR59392@freefall.freebsd.org>
X-Mailer: exmh version 2.0.2 2/24/98
To: Alex Dumas <dumas@pdx.or.com>
Cc: doc@freebsd.org
Subject: Re: man 7 man (or man(7)) 
In-Reply-To: Your message of "Fri, 02 Feb 2001 09:39:22 PST."
             <Pine.BSI.4.05L.10102020915240.5681-100000@pdx.or.com> 
Mime-Version: 1.0
Content-Type: text/plain
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org



> Have you or the other documentation folks considered including an
> optional, but encouraged "NOTES" section in man pages?

While the man(7) page does not mention this, the mdoc(7) page does say
that:

  ``
  .Sh Section Headers
      ...
      other	Customized headers may be added at the authors discretion.
  ''

Incidentally, a number of manual pages already have NOTES sections.

$ find /usr/share/man/man* -type f -print | xargs zgrep '^\.[Ss][Hh].*NOT' |\
  wc -l
      765

We might as well make ``.Sh NOTES'' part of the approved mandoc style.

Regards,
Koshy
<jkoshy@freebsd.org>


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message