[Pkg-nagios-devel] Bug#525168: Bug#525168: nagios-plugins-standard: Provide minimum docs for plugins

[Olivier Berger]

Le mercredi 22 avril 2009 à 20:32 +0200, Jan Wagner a écrit :
> Hi Olivier,
> 

Hi.

> On Wednesday 22 April 2009, Olivier Berger wrote:
> > There should be a minimal documentation (maybe a README) for plugins.
> 
> what are you expecting in such documentation?
> 

Well, at least something basic
in /usr/share/doc/nagios-plugins-standard/README advising the user on
where to find docs : URLs and/or indicating how to get more details, for
instance exliciting that the plugins' scripts can be issued with --help.

> > It's fr from obvious how to use them, until one discovers that invoking
> > them with --help provides a manpage.
> 
> Hmm ... isn't that one of the standard way in *nix environments to get "help"?
> 

Well, for normal "commands" meant for users, which reside in /usr/bin
and likes, yes, but for scripts which may not necessarily be "commands"
at first sight, that may not be so much natural : it's not obvious
(unless one knows details of nagios implementation) that such plugins
are actually scripts that can be launched from the CLI (and not some
kind of libraries invoked by some nagios daemon under some more complex
invocation protocol).

> With kind regards, Jan.

I hope I made my point clearer now.

Thanks for caring.

Best regards,
-- 
Olivier BERGER <olivier.berger at it-sudparis.eu>
http://www-public.it-sudparis.eu/~berger_o/ - OpenPGP-Id: 1024D/6B829EEC
Ingénieur Recherche - Dept INF
Institut TELECOM, SudParis (http://www.it-sudparis.eu/), Evry (France)