[Nagiosplug-checkins] Nagios-Plugin/lib/Nagios Plugin.pm,1.5,1.6
Nathan Vonnahme
n8v at users.sourceforge.net
Thu Sep 7 02:53:53 CEST 2006
Update of /cvsroot/nagiosplug/Nagios-Plugin/lib/Nagios
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv10810/lib/Nagios
Modified Files:
Plugin.pm
Log Message:
adding example script and test for it, and fixing POD according to warnings from POD::Checker
Index: Plugin.pm
===================================================================
RCS file: /cvsroot/nagiosplug/Nagios-Plugin/lib/Nagios/Plugin.pm,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Plugin.pm 31 Aug 2006 08:19:01 -0000 1.5
+++ Plugin.pm 7 Sep 2006 00:53:51 -0000 1.6
@@ -86,6 +86,12 @@
easy as possible for developers to conform to the plugin guidelines
(http://nagiosplug.sourceforge.net/developer-guidelines.html).
+=head1 EXAMPLE SCRIPT
+
+"Enough talk! Show me where to start!"
+
+See the file 'check_stuff.pl' in the 't' directory for a complete working example of a plugin script.
+
=head1 DESIGN
To facilitate object oriented classes, there are multiple perl modules, each reflecting a type of data
@@ -105,22 +111,30 @@
These modules are experimental and so the interfaces may change up until Nagios::Plugin
hits version 1.0, but every attempt will be made to make backwards compatible.
-=over 4
-
=head1 STARTING
+=over 4
+
=item use Nagios::Plugin qw(%ERRORS)
Imports the %ERRORS hash. This is currently the only symbol that can be imported.
+=back
+
=head1 CLASS METHODS
+=over 4
+
=item Nagios::Plugin->new( shortname => $$ )
Initializes a new Nagios::Plugin object. Can specify the shortname here.
+=back
+
=head1 OBJECT METHODS
+=over 4
+
=item set_thresholds( warning => "10:25", critical => "~:25" )
Sets the thresholds, based on the range specification at
@@ -147,9 +161,13 @@
=head1 AUTHOR
-Ton Voon, E<lt>ton.voon at altinity.comE<gt>
+Maintained by the Nagios Plugin development team - http://nagiosplug.sourceforge.net
-Thanks to Nathan Vonnahme for loads of extra tests and subsequent fixes.
+Originally by Ton Voon, E<lt>ton.voon at altinity.comE<gt>
+
+Nathan Vonnahme added extra tests and subsequent fixes.
+
+Gavin Carr contributed the Nagios::Plugin::GetOpt module.
=head1 COPYRIGHT AND LICENSE
More information about the Commits
mailing list