Bug#548229: ksnapshot has no man page
On Fri, Sep 25, 2009 at 06:01:18PM +0200, Frederik Schwarzer wrote:
> [Ana Guerrero | Friday 25 September 2009]
> > On Thu, Sep 24, 2009 at 05:50:04PM -0400, Daniel Bolton wrote:
> > > Armin,
> > >
> > > I have attached a man page.
> >
> > Thanks, but could you provide an *useful* manpage? The manpage you have
> > attached just shows the output of "ksnapshot --help", if we thought this
> > is useful we already would have added this automatically long time
> > ago...
>
> Could you define "useful"? I saw some manpages that basically state the
> --help output with one or two sentences above to explain what the tool is
> for.
Yes, there is plenty of no useful manpages. That is not excuse to add more.
About what is useful from my POV, if after reading a manpage you know something
else about what you can do with the app.
For example, look at "ark" manpage (sadly, outdated) it not only includes the
relevant output of --help (it skip the generic options), it also includes
examples of how to use the app, what to read to know more ("see also" paragprah),
ark's maintainer, where to find more information about ark, a long description about
ark...
And it could include more stuff like where to report bugs...
Ana
Reply to: