Re: Should we standardize a way to create and maintain manpages?
On Wed, Dec 23, 2020 at 10:12:57AM +0200, Andrius Merkys wrote:
> On 2020-12-22 17:58, olivier sallou wrote:
> > maintaining man pages is quite a hell when not provided, depends on
> > tool "help" , customize which option to get for help, and result in
> > quite often non up-to-date man pages... :-(
> >
> > I usually don't... as quite often *xxx -h* is verbose enough to give
> > software hints/usage and do not need a man page.
>
> This sums up my opinion quite well too. I'm not sure if outdated
> manpages aren't worse than none at all, as lack of a manpage at least
> redirects the user to search for the usage information elsewhere. Thus
> I'd better dodge a no-manual-page lintian warning :)
This would possibly offer a new way to create our manpages:
Fetch
.SH NAME
from short description and simply add a hint how to call the help
screen of the program in question. We "simply" need to find out
what option will show some help and add this to the manpage. So
we offer a hint how to get help properly.
What do you think about it?
Kind regards
Andreas.
--
http://fam-tille.de
Reply to: