[Nagiosplug-help] Plug-ins Documentation

Andreas Ericsson ae at op5.se
Sat Mar 27 12:17:03 CET 2004


Warrick FitzGerald wrote:
> How are you with docbook?
> 
Why not use the unix man-page format? It's really, really simple.
Or better still, maintain it as a texinfo document, like the CVS 
documentation (info cvs).

> [Warrick FitzGerald] 
> I don't have any practical experience myself, however there's no time
> like the present to learn (Seems pretty straight forward). My approach
> would be:
> 
> - Pick a plug-in (My Preference would be check_http to start)
> - Write a basic man page in plain ASCII 
> - Decide on a standard docbook format for all docs to come. Although
> docbook is a standard we should try to keep all the docs structured the
> same.
> - Convert it to docbook
> - Submit it to group ... where you can point out bad docbook syntax if
> necessary. Correct syntax and move onto the next.
>  
-- 
Mvh
Andreas Ericsson
OP5 AB
+46 (0)733 709032
andreas.ericsson at op5.se




More information about the Help mailing list