updated Makefile.PL to reflect changes in PR#1 by @chorny - tested - updated readme
[Nagios-Plugin.git] / README
blob5befaf4bcc7b6b9577f26b1d70e5ebd2a8f5e5d2
1 Nagios::Monitoring::Plugin
2 ==============
4 These modules are meant for [perl developers of plugins for Nagios](https://github.com/nagios-plugins/nagios-plugin-perl). 
5 It is meant to simplify a lot of the common functions required to do checking of a particular service.
7 The modules are still in an experimental stage and will be considered 
8 stable when it reaches version 1.0.
10 Installing
11 ----------
13 You may need some prerequisites first. If you're on RHEL/Cent, it would be:
15     yum install -y perl-devel perl-Class-Accessor perl-Config-Tiny perl-Math-Calc-Units
17 To install this module type the following:
19     perl Makefile.PL
20     make
21     make test
22     make install
25 Example
26 -------
28 "Enough talk!  Show me where to start!"
30 See the file 'check_stuff.pl' in the 't' directory for a complete 
31 working example of a plugin script.
34 License Notice
35 --------------
37 Copyright (C) 2006-2017 by Nagios Plugin Development Team
39 This library is free software; you can redistribute it and/or modify
40 it under the same terms as Perl itself, either Perl version 5.8.4 or,
41 at your option, any later version of Perl 5 you may have available.