Merge remote-tracking branch 'origin/collectd-5.8'

[collectd.git] / src / collectd-nagios.pod

diff --git a/src/collectd-nagios.pod b/src/collectd-nagios.pod
index 4980025..4ff0bf6 100644 (file)
--- a/src/collectd-nagios.pod
+++ b/src/collectd-nagios.pod
@@ -1,3 +1,5 @@
+=encoding UTF-8
+

 =head1 NAME
 
 collectd-nagios - Nagios plugin for querying collectd
 =head1 NAME
 
 collectd-nagios - Nagios plugin for querying collectd


@@ -63,6 +65,12 @@ The warning and critical ranges are applied to the average of all values.
 
 The warning and critical ranges are applied to the sum of all values.
 
 
 The warning and critical ranges are applied to the sum of all values.
 

+=item B<percentage>
+
+The warning and critical ranges are applied to the ratio (in percent) of the
+first value and the sum of all values. A warning is returned if the first
+value is not defined or if all values sum up to zero.
+

 =back
 
 =item B<-c> I<range>
 =back
 
 =item B<-c> I<range>


@@ -88,15 +96,21 @@ I<min> (and the colon) may be omitted,
 I<min> is then assumed to be zero. If I<max> (but not the trailing colon) is
 omitted, I<max> is assumed to be positive infinity.
 
 I<min> is then assumed to be zero. If I<max> (but not the trailing colon) is
 omitted, I<max> is assumed to be positive infinity.
 

+=item B<-m>
+
+If this option is given, "Not a Number" (NaN) is treated as I<critical>. By
+default, the I<none> consolidation reports NaNs as I<warning>. Other
+consolidations simply ignore NaN values.
+

 =back
 
 =head1 RETURN VALUE
 
 As usual for Nagios plugins, this program writes a short, one line status
 =back
 
 =head1 RETURN VALUE
 
 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
+message to STDOUT and signals success or failure with its return value. It

 exits with a return value of B<0> for I<success>, B<1> for I<warning> and B<2>
 for I<critical>. If the values are not available or some other error occurred,
 exits with a return value of B<0> for I<success>, B<1> for I<warning> and B<2>
 for I<critical>. If the values are not available or some other error occurred,

-it returns B<3> for I<unknown>. 
+it returns B<3> for I<unknown>.

 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 


@@ -107,6 +121,6 @@ L<http://nagios.org/>
 
 =head1 AUTHOR
 
 
 =head1 AUTHOR
 

-Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>
+Florian Forster E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt>

 
 =cut
 
 =cut