[Nagiosplug-help] Plug-ins Documentation

[Karl DeBisschop]

On Sat, 27 Mar 2004 16:16:45 -0500
"Warrick FitzGerald" <wfitzgerald at LiveTechnology.com> wrote:

> I also like the idea of keeping comments embedded in the code, but I
> personally feel the biggest problem that most man pages have is the
> lack of examples. People rarely have a problem with a specific
> parameter; they normally have something they are trying to achieve and
> are not really sure how to go about combining all the parameters to
> achieve it. 
> 
> I guess what I'm saying is that I like your idea, but would like to
> expand it to include a general "introduction" to each plug-in, as well
> as real examples.
> 
> I'll spend some time this weekend going through your check_pgsql code,
> follow your examples there and see what I can come up with.

Rehardless of what format ends up being used for documentation, we will
be glad to accept patches to the plugins to improve the documentation.
Even if it's just raw text, it's actually rather easy to take the raw
text and put it into the code of the plugin.

--
Karl