Code

Preparation for 1.4.13
[nagiosplug.git] / README
1 Nagios Plugins README
2 ---------------------
4 * For instructions on installing these plugins for use with Nagios,
5   see below. In addition, generic instructions for the GNU toolchain
6   can be found in the INSTALL file.
8 * For major changes between releases, read the NEWS file.
10 * For information on detailed changes that have been made or plugins 
11   that have been added, read the Changelog file.
13 * Some plugins require that you have additional programs and/or
14   libraries installed on your system before they can be used.  Plugins
15   that are dependent on other programs/libraries that are missing are
16   usually not compiled. Read the REQUIREMENTS file for more information.
18 * For a list of outstanding bugs for this release, see the BUGS file.
20 * Individual plugins are self documenting.  All plugins that comply with
21   the basic guidelines for development will provide detailed help when
22   invoked with the '-h' or '--help' options.
24 * The file command.cfg contains example configurations for many of the
25   plugins
27 * The win32 subdir contains plugins specific to the Win32 platform. 
28   These are scripts or binaries.
30 You can check for the latest plugins at:
31   http://sourceforge.net/projects/nagiosplug/
33 Send mail to nagiosplug-help@lists.sourceforge.net for assistance.  Please
34 include the OS type and version that you are using.  Also, run the plugin with
35 the '-vvv' option and provide the resulting version information.  Of course, 
36 there may be additional diagnostic information required as well.  Use good
37 judgment.
39 Send mail to nagiosplug-devel@lists.sourceforge.net for developer discussions.
41 For patch submissions and bug reports, please use the appropriate resources at
42 http://sourceforge.net/projects/nagiosplug/ (navigate to the bug tool and/or
43 patch tool from the summary page).  Patches should be relative to the current
44 CVS head (development), or to the head of the current stable branch. Also, 
45 please include version information for your OS and the plugin(s) your are 
46 patching/reporting.
51 Nagios Plugins Quick-and-Dirty Installation Instructions
52 --------------------------------------------------------
54 0) If you are using the CVS tree, you will need m4, gettext, automake, and autoconf. 
55    To start out, run ./tools/setup
57    For more detail, see the developer guidelines at 
58    http://nagiosplug.sourceforge.net/developer-guidelines.html.
61 1) Run the configure script to initialize variables and create a Makefile, etc.
63         ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL
65    a) Replace BASEDIRECTORY with the path of the directory under which Nagios
66       is installed (default is '/usr/local/nagios')
67    b) Replace CGIURL with the path used to access the Nagios CGIs with
68       a web browser (default is '/nagios/cgi-bin')
71 2) Compile the plugins with the following command:
73         make
76 3) Install the compiled plugins and plugin scripts with the following command:
78         make install
80    The installation procedure will attempt to place the plugins in a 
81    'libexec/' subdirectory in the base directory you specified with
82    the --prefix argument to the configure script.
84 4) There are some plugins that require setuid. If you run make install as 
85    a non root user, they will not be installed. To install, switch to root and 
86    run:
88         make install-root
90 5) Verify that your host configuration file (hosts.cfg) for Nagios contains
91    the correct paths to the new plugins.
95 That's it! If you have any problems or questions, feel free send mail
96 to nagiosplug-help@lists.sourceforge.net
100 LICENSE STUFF
101 -------------
103 This software is released under the GNU Public License with the additional
104 exemption that compiling, linking and/or using OpenSSL is allowed.
106 See the COPYING file for the complete GPL text. 
109 --
110 Nagios Plugins Team