diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 106 |
1 files changed, 52 insertions, 54 deletions
| @@ -1,98 +1,96 @@ | |||
| 1 | Nagios Plugins README | 1 | Nagios Plugins README |
| 2 | --------------------- | 2 | ===================== |
| 3 | 3 | ||
| 4 | * For instructions on installing these plugins for use with Nagios, | 4 | * For instructions on installing these plugins for use with Nagios, |
| 5 | see below. In addition, generic instructions for the GNU toolchain | 5 | see below. In addition, generic instructions for the GNU toolchain can be |
| 6 | can be found in the INSTALL file. | 6 | found in the `INSTALL` file. |
| 7 | 7 | ||
| 8 | * For major changes between releases, read the NEWS file. | 8 | * For major changes between releases, read the `NEWS` file. |
| 9 | 9 | ||
| 10 | * For information on detailed changes that have been made or plugins | 10 | * For information on detailed changes that have been made or plugins |
| 11 | that have been added, read the Changelog file. | 11 | that have been added, read the `ChangeLog` file. |
| 12 | 12 | ||
| 13 | * Some plugins require that you have additional programs and/or | 13 | * Some plugins require that you have additional programs and/or |
| 14 | libraries installed on your system before they can be used. Plugins | 14 | libraries installed on your system before they can be used. Plugins that |
| 15 | that are dependent on other programs/libraries that are missing are | 15 | are dependent on other programs/libraries that are missing are usually not |
| 16 | usually not compiled. Read the REQUIREMENTS file for more information. | 16 | compiled. Read the `REQUIREMENTS` file for more information. |
| 17 | 17 | ||
| 18 | * For a list of outstanding bugs for this release, see the BUGS file. | 18 | * For a list of outstanding bugs for this release, see the `BUGS` file. |
| 19 | 19 | ||
| 20 | * Individual plugins are self documenting. All plugins that comply with | 20 | * Individual plugins are self documenting. All plugins that comply with |
| 21 | the basic guidelines for development will provide detailed help when | 21 | the basic guidelines for development will provide detailed help when |
| 22 | invoked with the '-h' or '--help' options. | 22 | invoked with the `-h` or `--help` options. |
| 23 | 23 | ||
| 24 | You can check for the latest plugins at: | 24 | You can check for the latest plugins at: |
| 25 | http://sourceforge.net/projects/nagiosplug/ | ||
| 26 | 25 | ||
| 27 | Send mail to nagiosplug-help@lists.sourceforge.net for assistance. Please | 26 | * <https://sourceforge.net/projects/nagiosplug/> |
| 28 | include the OS type and version that you are using. Also, run the plugin with | ||
| 29 | the '-vvv' option and provide the resulting version information. Of course, | ||
| 30 | there may be additional diagnostic information required as well. Use good | ||
| 31 | judgment. | ||
| 32 | 27 | ||
| 33 | Send mail to nagiosplug-devel@lists.sourceforge.net for developer discussions. | 28 | Send an email to <nagiosplug-help@lists.sourceforge.net> for assistance. |
| 29 | Please include the OS type and version that you are using. Also, run the | ||
| 30 | plugin with the `-vvv` option and provide the resulting version information. | ||
| 31 | Of course, there may be additional diagnostic information required as well. | ||
| 32 | Use good judgment. | ||
| 34 | 33 | ||
| 35 | For patch submissions and bug reports, please use the appropriate resources at | 34 | Send an email to <nagiosplug-devel@lists.sourceforge.net> for developer |
| 36 | https://github.com/nagios-plugins/nagios-plugins/. Also, please include | 35 | discussions. |
| 37 | version information for your OS and the plugin(s) your are patching/reporting. | ||
| 38 | 36 | ||
| 37 | For patch submissions and bug reports, please use the appropriate resources | ||
| 38 | at <https://github.com/nagios-plugins/nagios-plugins>. | ||
| 39 | 39 | ||
| 40 | 40 | ||
| 41 | Installation Instructions | ||
| 42 | ------------------------- | ||
| 41 | 43 | ||
| 42 | Nagios Plugins Quick-and-Dirty Installation Instructions | 44 | 1. If you are using the Git tree, you will need m4, gettext, automake, and |
| 43 | -------------------------------------------------------- | 45 | autoconf. To start out, run: |
| 44 | 46 | ||
| 45 | 0) If you are using the Git tree, you will need m4, gettext, automake, and autoconf. | 47 | ./tools/setup |
| 46 | To start out, run ./tools/setup | ||
| 47 | 48 | ||
| 48 | For more detail, see the developer guidelines at | 49 | For more detail, see the developer guidelines at |
| 49 | http://nagiosplug.sourceforge.net/developer-guidelines.html. | 50 | <http://nagiosplug.sourceforge.net/developer-guidelines.html>. |
| 50 | 51 | ||
| 51 | 52 | 2. Run the configure script to initialize variables and create a Makefile, | |
| 52 | 1) Run the configure script to initialize variables and create a Makefile, etc. | 53 | etc. |
| 53 | 54 | ||
| 54 | ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL | 55 | ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL |
| 55 | 56 | ||
| 56 | a) Replace BASEDIRECTORY with the path of the directory under which Nagios | 57 | * Replace `BASEDIRECTORY` with the path of the directory under which |
| 57 | is installed (default is '/usr/local/nagios') | 58 | Nagios is installed (default is `/usr/local/nagios`). |
| 58 | b) Replace CGIURL with the path used to access the Nagios CGIs with | 59 | * Replace `CGIURL` with the path used to access the Nagios CGIs with a |
| 59 | a web browser (default is '/nagios/cgi-bin') | 60 | web browser (default is `/nagios/cgi-bin`). |
| 60 | |||
| 61 | 61 | ||
| 62 | 2) Compile the plugins with the following command: | 62 | 3. Compile the plugins with the following command: |
| 63 | 63 | ||
| 64 | make | 64 | make |
| 65 | 65 | ||
| 66 | 66 | 4. Install the compiled plugins and plugin scripts with the following | |
| 67 | 3) Install the compiled plugins and plugin scripts with the following command: | 67 | command: |
| 68 | 68 | ||
| 69 | make install | 69 | make install |
| 70 | 70 | ||
| 71 | The installation procedure will attempt to place the plugins in a | 71 | The installation procedure will attempt to place the plugins in a |
| 72 | 'libexec/' subdirectory in the base directory you specified with | 72 | `libexec/` subdirectory in the base directory you specified with the |
| 73 | the --prefix argument to the configure script. | 73 | `--prefix` argument to the configure script. |
| 74 | 74 | ||
| 75 | 4) There are some plugins that require setuid. If you run make install as | 75 | 5. There are some plugins that require setuid. If you run make install as |
| 76 | a non root user, they will not be installed. To install, switch to root and | 76 | a non-root user, they will not be installed. To install, switch to root |
| 77 | run: | 77 | and run: |
| 78 | 78 | ||
| 79 | make install-root | 79 | make install-root |
| 80 | 80 | ||
| 81 | 81 | That's it! If you have any problems or questions, feel free to send an | |
| 82 | That's it! If you have any problems or questions, feel free send mail | 82 | email to <nagiosplug-help@lists.sourceforge.net>. |
| 83 | to nagiosplug-help@lists.sourceforge.net | ||
| 84 | |||
| 85 | 83 | ||
| 86 | 84 | ||
| 87 | LICENSE STUFF | 85 | License Stuff |
| 88 | ------------- | 86 | ------------- |
| 89 | 87 | ||
| 90 | This software is released under the GNU Public License, Version 3, with the | 88 | This software is released under the GNU General Public License, Version 3, |
| 91 | additional exemption that compiling, linking and/or using OpenSSL is | 89 | with the additional exemption that compiling, linking and/or using OpenSSL |
| 92 | allowed. | 90 | is allowed. |
| 93 | 91 | ||
| 94 | See the COPYING file for the complete GPLv3 text. | 92 | See the `COPYING` file for the complete GPLv3 text. |
| 95 | 93 | ||
| 96 | 94 | ||
| 97 | -- | 95 | -- |
| 98 | Nagios Plugins Team | 96 | Nagios Plugins Development Team |