Re: Manual pages for GNU programs: template
On Tue, 7 Jan 1997, Lars Wirzenius wrote:
> [ Please don't Cc: me when replying to my message on a mailing list. ]
>
> Winfried Truemper:
> > IMHO, man-pages are technical references. As such, they should be
> > "complete".
>
> For real manual pages, yes, but this is supposed to be a quick way
> to get at least some useful information (command line synopsis) and
> a pointer to the real manual. If we require Debian maintainers to
> rewrite the Info files as manual pages, it will cause them much
> more work, and I don't think that's a good idea.
IMHO tar(1) (as of tar-1.11.8-5) is a perfect implementation of our
template (did you copy it from there?). It covers each command line option
with a single line of description and mentions in the "BUGS" section, that
the page isn't complete and one should check the info page. However, the
"SYNOPSIS" is way to long. IMHO the options must not all be included in
the SYNOPSIS.
Just my 2 cents,
Chris
-- _,, Christian Schwarz
/ o \__ schwarz@monet.m.isar.de, schwarz@debian.org,
! ___; schwarz@mathematik.tu-muenchen.de, bm955877@muenchen.org
\ /
\\\______/ ! PGP-fp: 8F 61 EB 6D CF 23 CA D7 34 05 14 5C C8 DC 22 BA
\ / http://fatman.mathematik.tu-muenchen.de/~schwarz/
-.-.,---,-,-..---,-,-.,----.-.-
"DIE ENTE BLEIBT DRAUSSEN!"
--
TO UNSUBSCRIBE FROM THIS MAILING LIST: e-mail the word "unsubscribe" to
debian-devel-REQUEST@lists.debian.org . Trouble? e-mail to Bruce@Pixar.com
Reply to: