Subject: Re: bin/7249
To: None <tech-kern@netbsd.org>
From: Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk>
List: tech-kern
Date: 07/19/2000 12:24:40
On Tue, Jul 18, 2000 at 05:19:10PM -0400, dsr@mail.lns.cornell.edu wrote:
> 1) One of the great strengths of the Unix man pages is the conventional
> structure--NAME, SYNOPSIS, PARAMETERS, DESCRIPTION, RETURN VALUES, etc.
> Seriously, I'm not kidding--consistency in technical documentation is
> *highly* desirable, and the man pages have a structure that, for the
> most part, works well. If we're going to consider replacing them, the
> replacement ought to directly support, even enforce, the conventional
> structure.
I agree with this totally. The on-line documentation on the NetBSD
system is very good compared with documentation on other systems. It
is reasonably easy to find what one wants. I wouldn't like to see
the NetBSD documentation spoilt in favour of a new format.
However, I would not be against having the option of documentation in
other formats on the system, __provided__ that we don't end up in
the situation of other systems, where I have to use man, info, and look
in /usr/doc in 3-4 different formats. Perhaps a /usr/share/doc/html
directory or something like that?
--
Chris