[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Requirement for a “proper manpage” for every command

Manoj Srivastava dijo [Mon, Mar 02, 2009 at 02:22:57PM -0600]:
> > Hmh, this could even be promoted as a "best packaging practice". Many
> > authors do ship properly-formatted --help entries, and our
> > hand-generated manpages can often linger behind the truth. Any strong
> > opinions against? 
>         I would not call it best. Barely adequate, perhaps. Could do
>  better, certainly.  Best practrice would be to write up a real man
>  page, perhaps using the help2man as a starting point.

I agree - But at least its output is equivalent in quality to a couple
of manpages I have hand-generated (i.e. documenting a somewhat-obscure
command or one for which the --help output is just enough). For one of
them I have already ditched my man page for a call to help2man in
debian/rules' install - It will at least make sure I don't skip any
changes introduced upstream.


Gunnar Wolf - gwolf@gwolf.org - (+52-55)5623-0154 / 1451-2244
PGP key 1024D/8BB527AF 2001-10-23
Fingerprint: 0C79 D2D1 2C4E 9CE4 5973  F800 D80E F35A 8BB5 27AF

Reply to: