check_host: Allocate a large-enough buffer for the host table.

[nagiosplug.git] / README

diff --git a/README b/README
index 9b781a5d3b53474f0d9f4fcabf8fc5584d7bf21d..b06d5b5d8ced7714fd507c0f617e3ffbcb1e3a04 100644 (file)
--- a/README
+++ b/README
@@ -5,7 +5,7 @@ Nagios Plugins README
   see below. In addition, generic instructions for the GNU toolchain
   can be found in the INSTALL file.
 
-* For major changes between releases, read the CHANGES file.
+* For major changes between releases, read the NEWS file.
 
 * For information on detailed changes that have been made or plugins 
   that have been added, read the Changelog file.
@@ -15,6 +15,8 @@ Nagios Plugins README
   that are dependent on other programs/libraries that are missing are
   usually not compiled. Read the REQUIREMENTS file for more information.
 
+* For a list of outstanding bugs for this release, see the BUGS file.
+
 * Individual plugins are self documenting.  All plugins that comply with
   the basic guidelines for development will provide detailed help when
   invoked with the '-h' or '--help' options.
@@ -22,13 +24,15 @@ Nagios Plugins README
 * The file command.cfg contains example configurations for many of the
   plugins
 
+* The win32 subdir contains plugins specific to the Win32 platform. 
+  These are scripts or binaries.
+
 You can check for the latest plugins at:
-  ftp://download.sourceforge.net/pub/sourceforge/nagiosplug
   http://sourceforge.net/projects/nagiosplug/
 
 Send mail to nagiosplug-help@lists.sourceforge.net for assistance.  Please
 include the OS type and version that you are using.  Also, run the plugin with
-the '-v' option and provide the resulting version information.  Of course, 
+the '-vvv' option and provide the resulting version information.  Of course, 
 there may be additional diagnostic information required as well.  Use good
 judgment.
 
@@ -47,26 +51,20 @@ patching/reporting.
 Nagios Plugins Quick-and-Dirty Installation Instructions
 --------------------------------------------------------
 
-0) If using the CVS tree, you need m4, gettext, automake, and autoconf. To
-   start out, run ./tools/setup
+0) If you are using the CVS tree, you will need m4, gettext, automake, and autoconf. 
+   To start out, run ./tools/setup
 
-   For development, we generally use the most recent stable tools from
-   the FSF. Currently we use gettext 0.11.5, autoconf 2.58, and
-   automake 1.7.9. You may see warnings or errors with other versions,
-   particularly with autoconf < 2.54.
+   For more detail, see the developer guidelines at 
+   http://nagiosplug.sourceforge.net/developer-guidelines.html.
 
 
 1) Run the configure script to initialize variables and create a Makefile, etc.
 
-       ./configure --prefix=BASEDIRECTORY --with-nagios-user=SOMEUSER --with-nagios-group=SOMEGROUP --with-cgiurl=SOMEURL
+       ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL
 
    a) Replace BASEDIRECTORY with the path of the directory under which Nagios
       is installed (default is '/usr/local/nagios')
-   b) Replace SOMEUSER with the name of a user on your system that will be
-      assigned permissions to the installed plugins (default is 'nagios')
-   c) Replace SOMEGRP with the name of a group on your system that will be
-      assigned permissions to the installed plugins (default is 'nagios')
-   d) Replace CGIURL with the path used to access the Nagios CGIs with
+   b) Replace CGIURL with the path used to access the Nagios CGIs with
       a web browser (default is '/nagios/cgi-bin')
 
 
@@ -83,17 +81,30 @@ Nagios Plugins Quick-and-Dirty Installation Instructions
    'libexec/' subdirectory in the base directory you specified with
    the --prefix argument to the configure script.
 
+4) There are some plugins that require setuid. If you run make install as 
+   a non root user, they will not be installed. To install, switch to root and 
+   run:
+
+       make install-root
 
-4) Verify that your host configuration file (hosts.cfg) for Nagios contains
+5) Verify that your host configuration file (hosts.cfg) for Nagios contains
    the correct paths to the new plugins.
 
 
 
-That's it.  If you have any problems or questions, feel free send mail
-to nagios-users@lists.sourceforge.net or nagiosplug-help@lists.sourceforge.net
+That's it! If you have any problems or questions, feel free send mail
+to nagiosplug-help@lists.sourceforge.net
+
+
+
+LICENSE STUFF
+-------------
 
+This software is released under the GNU Public License with the additional
+exemption that compiling, linking and/or using OpenSSL is allowed.
 
+See the COPYING file for the complete GPL text. 
 
 
 --
-Karl DeBisschop (kdebisschop@users.sourceforge.net)
+Nagios Plugins Team