Bug#39830: [AMENDMENT]: get rid of undocumented(7) symlinks
On Wed, Oct 30, 2002 at 06:02:42PM -0500, Branden Robinson wrote:
> On Wed, Oct 30, 2002 at 11:09:25AM +0000, Colin Watson wrote:
> > + It is not very hard to write a man page. See the <url
> > + id="http://www.schweikhardt.net/man_page_howto.html";
> > + name="Man-Page-HOWTO">, <tt>man(7)</tt>, the examples
> > + created by <tt>debmake</tt> or <tt>dh_make</tt>, or the
> > + directory <file>/usr/share/doc/man-db/examples</file>.
>
> Now weren't you just telling me a couple of weeks ago not to go by
> man(7) because it documents obsolete constructs?
I'm just more-or-less copying the original diff in an attempt to
minimize contention. Evidently it didn't work. :)
Like the Man-Page-HOWTO, it's better than nothing, and worse than the
best. Many things are. However, the best in this case is generally terse
technical documentation, which is fine if you really want to know how
the macro sets work but less good if you want to provide an introduction
for novices. groff_man(7) and the info documentation, regrettably, are
not really at the novice level.
I think it's OK to refer people to man(7) and fix its deficiencies as we
go along.
--
Colin Watson [cjwatson@flatline.org.uk]
Reply to: