Remove .svn files in distribution
[monitoring-plugins.git] / FAQ
blob5ba948f1453fc162dc65d3f124e504a301c09397
1 Frequently Asked Questions
2 **************************
4 Q: Where can I find documentation for <insert name> plugin?
6 A: All plugins that comply with minimal development guideline for
7    this project include internal documentation.  The documentation
8    can be read executing plugin with the -h or --help option. If 
9    the '-h' option does not work, that is a bug.
12 Q: What version of <insert name> plugin am I running?
14 A: All plugins that comply with minimal development guideline for
15    this project include detailed version information.  When executed
16    with the '-V' option, a version string will be printed:
18    check_radius (nagios-plugins 1.3.0-alpha1) 1.11
20    Note that this string include both the assigned package release
21    name and the CVS-generated revision for the individual plugin.
22    Authors should strictly adhere to this format.  All bug reports
23    and help requests should reference this information.
26 Q: What information do I need to include when asking for help or
27    submitting a bug report?
29 A: At a minimum, the output from 'uname -a' and the version string
30    from '<plugin_name> -V' and, of course, a description of the
31    problem and any solution/patch.
34 Q: I'm using Redhat Linux (or some other RPM-based distribution).
35    Which packages should I install?
37 A: The package nagios-plugins-<version>.<arch>.rpm contains only
38    those plugins that should work on any POSIX compliant system.  In
39    other words, you should be able to install this package on your
40    system, no matter what else is or in not installed.
42    However, most of us have more complex systems than barebones
43    POSIX.  We tried creating a variety of separate packages so
44    each dependency could be installed cleanly, but many people
45    found that this resulted in too many packages.  So in the end,
46    all the non-POSIX plugins were folded into one RPM 
47    (nagios-plugins-<version>.<arch>.rpm).  Most people will need to
48    use RPM's '--nodeps' option to install this package.
51 Q: My system uses the .deb package format. What packages should I
52    install?
54 A: We strive for cooperation between all packagers and developers.
55    The answers for .deb are the same as for RPM, after changing the
56    package name suffixes accordingly.
59 Q: I prefer to build my own RPMs. Do I need to install all of the
60    various dependencies?
62 A: Beginning with the 1.2.9-1 release, you may run
64    rpm --define 'custom 1' -ta nagios-plugins-<release>.tar.gz
66    In prior releases, you must unpack the tarball and build the
67    RPM using nagios-custom.spec with 'rpm -ba'.
70 Q: I get an error like
72    Warning: Return code of 127 for check of service 'PING' on host 'anyhost' was out of bounds.
74    when I run Nagios. (Often check_ping runs just fine on the
75    command line).
77 A: Commonly, system administrators will make security as tight as
78    possible on the monitoring system. Sometimes this includes OS
79    options or hardening scripts that prevent unprivileged users from
80    running the ping command. Nagios runs with no more privileges
81    than 'nobody' -- check to be sure that the nagios user can
82    actually run check ping.  (This can also happen with other binaries
83    executed by nagios, but ping seems to be far and away the biggest
84    offender.)
87 Q: I have a plugin to offer. What can I do?
89 A: You can make it available on NagiosExchange (http://nagiosexchange.org)
90    where other people can find it for use.
92    You can also get feedback on improving the plugin via the 
93    nagiosplug-devel@lists.sourceforge.net mailing list.