![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 6e72192661b5a1184cf0bd6a790f250f62848bfb..e3fe4c8c192f6d9a1bb272de2910160a449a4cf3 100644 (file)
</affiliation>
</author>
+ <author>
+ <firstname>Ton</firstname>
+ <surname>Voon</surname>
+ <affiliation>
+ <address><email>tonvoon@users.sourceforge.net</email></address>
+ </affiliation>
+ </author>
+
+ <author>
+ <firstname>Jeremy T</firstname>
+ <surname>Bouse</surname>
+ <affiliation>
+ <address><email>undrgrid@users.sourceforge.net</email></address>
+ </affiliation>
+ </author>
</authorgroup>
<pubdate>2002</pubdate>
<revhistory>
<revision>
- <revnumber>0.4</revnumber>
- <date>2 May 2002</date>
+ <revnumber>$Revision$</revnumber>
+ <date>$Date$</date>
</revision>
</revhistory>
<copyright>
- <year>2000 2001 2002</year>
- <holder>Karl DeBisschop, Ethan Galstad,
- Hugo Gayosso, Stanley Hopcroft, Subhendu Ghosh</holder>
+ <year>2000 - 2004</year>
+ <holder>Nagios Plugins Development Team</holder>
</copyright>
</bookinfo>
-v options for additional verbosity, up to a maximum of 3. The standard
type of output should be:</para>
- <table id="verbose_levels"><title>Verbose output levels</title>
+ <table id="verboselevels"><title>Verbose output levels</title>
<tgroup cols="2">
<thead>
<row>
<para>Notes:</para>
<orderedlist>
- <listitem><para>start > end></para>
+ <listitem><para>start > end</para>
</listitem>
<listitem><para>start and ":" is not required if start=0</para>
</listitem>
same UOM</para>
</listitem>
<listitem><para>warn and crit are in the range format (see
- <xref linkend="thresholdformat">)</para>
+ <xref linkend="thresholdformat">). Must be the same UOM</para>
</listitem>
<listitem><para>UOM (unit of measurement) is one of:</para>
<orderedlist>
<para>It is up to third party programs to convert the Nagios plugins
performance data into graphs.</para>
</section>
+
+ <section><title>Translations</title>
+ <para>If possible, use translation tools for all output. Currently, most of the core C plugins
+ use gettext for translation. General guidelines are:</para>
+
+ <orderedlist>
+ <listitem><para>short help is not translated</para></listitem>
+ <listitem><para>long help has options in English language, but text translated</para></listitem>
+ <listitem><para>"Copyright" kept in English</para></listitem>
+ <listitem><para>copyright holder names kept in original text</para></listitem>
+ </orderedlist>
+ </section>
</section>
<section id="SysCmdAuxFiles"><title>System Commands and Auxiliary Files</title>
<orderedlist>
<listitem><para> Do not use BEGIN and END blocks since they will be called
- the first time and when Nagios shuts down with Embedded Perl (ePN). In
+ only once (when Nagios starts and shuts down) with Embedded Perl (ePN). In
particular, do not use BEGIN blocks to initialize variables.</para>
</listitem>
<listitem><para>To use utils.pm, you need to provide a full path to the
- module in order for it to work with ePN.</para>
+ module in order for it to work.</para>
<literallayout>
e.g.
variable. </para>
- <para>Explicitly initialize each varialable in use. Otherwise with
- caching enabled, the plugin will not be recompilied each time, and
+ <para>Explicitly initialize each variable in use. Otherwise with
+ caching enabled, the plugin will not be recompiled each time, and
therefore Perl will not reinitialize all the variables. All old
variable values will still be in effect.</para>
</listitem>
- <listitem><para>Do not use > DATA < (these simply do not compile under ePN).</para>
+ <listitem><para>Do not use >DATA< handles (these simply do not compile under ePN).</para>
</listitem>
- <listitem><para>Do not use named subroutines</para>
+ <listitem><para>Do not use global variables in named subroutines. This is bad practise anyway, but with ePN the
+ compiler will report an error "<global_var> will not stay shared ..". Values used by
+ subroutines should be passed in the argument list.</para>
</listitem>
<listitem><para>If writing to a file (perhaps recording
<listitem><para>As in <xref linkend="runtime"> all plugins need
to monitor their runtime, specially if they are using network
- resources. Use of the <emphasis>alarm</emphasis> is recommended.
+ resources. Use of the <emphasis>alarm</emphasis> is recommended
+ noting that some Perl modules (eg LWP) manage timers, so that an alarm
+ set by a plugin using such a module is overwritten by the module.
+ (workarounds are cunning (TM) or using the module timer)
Plugins may import a default time out ($TIMEOUT) from utils.pm.
</para>
</listitem>
<para>The option -v or --verbose should be present in all plugins.
The user should be allowed to specify -v multiple times to increase
- the verbosity level, as described in <xref linkend="verbose_levels">.</para>
+ the verbosity level, as described in <xref linkend="verboselevels">.</para>
</section>
<section>
Credit will always be given for any patches through a THANKS file in the distribution.</para>
</section>
- <section id="New_plugins"><title>New plugins</title>
+ <section id="Newplugins"><title>New plugins</title>
<para>If you would like others to use your plugins and have it included in
the standard distribution, please include patches for the relevant
configuration files, in particular "configure.in". Otherwise submitted
</section>
+<section id="UsingSourceforge"><title>Using Sourceforge</title>
+<table id="Projectmemberaccess"><title>Project Member Access</title>
+ <tgroup cols="9">
+ <thead>
+ <row>
+ <entry><para>Member type</para></entry>
+ <entry><para>CVS Access</para></entry>
+ <entry><para>Shell Access</para></entry>
+ <entry><para>Release Tech</para></entry>
+ <entry><para>Tracker Manager</para></entry>
+ <entry><para>Task Manager</para></entry>
+ <entry><para>Forums</para></entry>
+ <entry><para>Doc Manager</para></entry>
+ <entry><para>News</para></entry>
+ <entry><para>Screenshots</para></entry>
+ <entry><para>Notes</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Translator</para></entry>
+ <entry><para>Yes</para></entry>
+ <entry><para>Yes</para></entry>
+ <entry><para>No</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>Add developer to CVSROOT/avail for translation files</para></entry>
+ </row>
+ <row>
+ <entry><para>Developer</para></entry>
+ <entry><para>Yes</para></entry>
+ <entry><para>Yes</para></entry>
+ <entry><para>No</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>A&T</para></entry>
+ <entry><para>Moderator</para></entry>
+ <entry><para>Editor</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>-</para></entry>
+ <entry><para>Need to set tracker access individually. Add developer to CVSROOT/avail for all files</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+</table>
+<para>Add all members to the nagiosplug-team mailing list</para>
+</section>
</article>
</book>