{GPL, other}: Relicense to MIT license.

[collectd.git] / src / collectd.pod

diff --git a/src/collectd.pod b/src/collectd.pod
index 2a326bb..8fccdb3 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -1,3 +1,5 @@
+=encoding UTF-8
+

 =head1 NAME
 
 collectd - System statistics collection daemon
 =head1 NAME
 
 collectd - System statistics collection daemon


@@ -31,6 +33,11 @@ directory.
 Test the configuration only. The program immediately exits after parsing the
 config file. A return code not equal to zero indicates an error.
 
 Test the configuration only. The program immediately exits after parsing the
 config file. A return code not equal to zero indicates an error.
 

+=item B<-T>
+
+Test the plugin read callbacks only. The program immediately exits after invoking
+the read callbacks once. A return code not equal to zero indicates an error.
+

 =item B<-P> I<E<lt>pid-fileE<gt>>
 
 Specify an alternative pid file. This overwrites any settings in the config 
 =item B<-P> I<E<lt>pid-fileE<gt>>
 
 Specify an alternative pid file. This overwrites any settings in the config 


@@ -89,11 +96,35 @@ C<logfile plugin> and the C<syslog plugin>. With these plugins collectd can
 provide information about issues and significant situations to the user.
 Several loglevels let you suppress uninteresting messages.
 
 provide information about issues and significant situations to the user.
 Several loglevels let you suppress uninteresting messages.
 

+Starting with version C<4.3.0> collectd has support for B<monitoring>. This is
+done by checking thresholds defined by the user. If a value is out of range, a
+notification will be dispatched to "notification plugins". See
+L<collectd.conf(5)> for more detailed information about threshold checking.
+

 Please note that some plugins, that provide other means of communicating with
 the daemon, have manpages of their own to describe their functionality in more
 detail. In particular those are L<collectd-email(5)>, L<collectd-exec(5)>,
 L<collectd-perl(5)>, L<collectd-snmp(5)>, and L<collectd-unixsock(5)>
 
 Please note that some plugins, that provide other means of communicating with
 the daemon, have manpages of their own to describe their functionality in more
 detail. In particular those are L<collectd-email(5)>, L<collectd-exec(5)>,
 L<collectd-perl(5)>, L<collectd-snmp(5)>, and L<collectd-unixsock(5)>
 

+=head1 SIGNALS
+
+B<collectd> accepts the following signals:
+
+=over 4
+
+=item B<SIGINT>, B<SIGTERM>
+
+These signals cause B<collectd> to shut down all plugins and terminate.
+
+=item B<SIGUSR1>
+
+This signal causes B<collectd> to signal all plugins to flush data from
+internal caches. E.E<nbsp>g. the C<rrdtool plugin> will write all pending data
+to the RRD files. This is the same as using the C<FLUSH -1> command of the
+C<unixsock plugin>.
+
+=back
+

 =head1 SEE ALSO
 
 L<collectd.conf(5)>,
 =head1 SEE ALSO
 
 L<collectd.conf(5)>,


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

-Florian Forster E<lt>octo@verplant.orgE<gt>
+Florian Forster E<lt>octo@collectd.orgE<gt>

 
 =cut
 
 =cut