src/common.c: Allow the `pwbufp' argument to `getpwnam_r' to be NULL.

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

diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod
index 6875694..7c0e316 100644 (file)
--- a/src/collectd-unixsock.pod
+++ b/src/collectd-unixsock.pod
@@ -20,6 +20,9 @@ the daemon. This can be used to use the values collected by collectd in other
 applications, such as monitoring, or submit externally collected values to
 collectd.
 
+This plugin is used by L<collectd-nagios(1)> to check if some value is in a
+certain range and exit with a Nagios-compatible exit code.
+
 =head1 COMMANDS
 
 Upon start the C<unixsock plugin> opens a UNIX-socket and waits for
@@ -51,10 +54,11 @@ Example:
 
 Submits a value (identified by I<Identifier>, see below) to the daemon which
 will dispatch it to all it's write-plugins. The I<Valuelist> is a
-colon-seperated list of values, either an integer if the data-source is a
-counter, of a double if the data-source if of type "gauge". You can submit an
-undefined gauge-value by using B<U>. When submitting B<U> to a counter the
-behavior is undefined.
+colon-seperated list of the time and the values, each either an integer if the
+data-source is a counter, of a double if the data-source if of type "gauge".
+You can submit an undefined gauge-value by using B<U>. When submitting B<U> to
+a counter the behavior is undefined. The time is given as epoch (i.E<nbsp>e.
+standard UNIX time).
 
 Example:
   -> | PUTVAL testhost/interface/if_octets-test0 1179574444:123:456
@@ -91,9 +95,19 @@ Commands that return values may use I<Num> to return the number of values that
 follow, such as the B<GETVAL> command. These commands usually return a negative
 value on failure and never return zero.
 
+=head1 ABSTRACTION LAYER
+
+Shipped with the sourcecode comes the Perl-Module L<Collectd::Unixsock> which
+provides an abstraction layer over the actual socket connection. It can be
+found in the directory F<contrib/PerlLib>. If you want to use Perl to
+communicate with the daemon, you're encouraged to use and expand this module.
+
 =head1 SEE ALSO
 
-L<collectd(1)>, L<collectd.conf(5)>, L<unix(7)>
+L<collectd(1)>,
+L<collectd.conf(5)>,
+L<collectd-nagios(1)>,
+L<unix(7)>
 
 =head1 AUTHOR