From c15b8401a52a76256e9c600a592beaf4c15e87a6 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Mon, 6 Oct 2008 23:53:37 +0200 Subject: [PATCH] collectd-nagios(1): Make the documentation easier to read, more correct and fix errors. --- src/collectd-nagios.pod | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/src/collectd-nagios.pod b/src/collectd-nagios.pod index 7b2442e5..49800255 100644 --- a/src/collectd-nagios.pod +++ b/src/collectd-nagios.pod @@ -45,7 +45,7 @@ handled according to the consolidation function given with the B<-g> option. =item B<-g> BI<|>BI<|>B -When multiple data sources are selected from a value spec they can be handled +When multiple data sources are selected from a value spec, they can be handled differently depending on this option. The values of the following meaning: =over 4 @@ -71,22 +71,32 @@ The warning and critical ranges are applied to the sum of all values. Set the critical (B<-c>) and warning (B<-w>) ranges. These options mostly follow the normal syntax of Nagios plugins. The general format is -"IB<:>I". If a value if smaller than I or bigger than I a -warning or critical is returned, otherwise okay is returned. I (and the -colon) may be omitted and are then assumed to be zero. If I (but not the -colon) is omitted I is set to positive infinity. If either I or -I if set to B<~> they are set to negative and positive infinity, -respectively. +"IB<:>I". If a value is smaller than I or bigger than I, a +I or I status is returned, otherwise the status is +I. + +The tilde sign (B<~>) can be used to explicitly specify infinity. If B<~> is +used as a I value, negative infinity is used. In case of I, it is +interpreted as positive infinity. + +If the first character of the I is the atEsign (B<@>), the meaning +of the range will be inverted. I.Ee. all values I the range will +yield a I or I status, while all values I the range +will result in a I status. + +I (and the colon) may be omitted, +I is then assumed to be zero. If I (but not the trailing colon) is +omitted, I is assumed to be positive infinity. =back =head1 RETURN VALUE -As usual for Nagios plugins this program writes a short, one line status +As usual for Nagios plugins, this program writes a short, one line status message to STDOUT and signals success or failure with it's return value. It -exists with a return value of B<0> for success or B<1> or B<2> for warning and -critical, respectively. If the values is not available or some other error -occurred it returns B<3> for "unknown". +exits with a return value of B<0> for I, B<1> for I and B<2> +for I. If the values are not available or some other error occurred, +it returns B<3> for I. =head1 SEE ALSO -- 2.11.0