X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.pod;h=8e68fc016ac2fea5faa2bfe7d58f0d7c30c51e05;hb=8858811d487e8edc576ff7b0216d663949055a66;hp=b55362a3d12296161a5347ce0826fdef8a5341fd;hpb=5aac2498eeacce2ab28302bca2103960a11474f7;p=collectd.git diff --git a/src/collectd.pod b/src/collectd.pod index b55362a3..8e68fc01 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =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. +=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> Ipid-fileE> Specify an alternative pid file. This overwrites any settings in the config @@ -42,7 +49,11 @@ config-option. Don't fork to the background. I will also B close standard file descriptors, detach from the session nor write a pid file. This is mainly -thought for 'supervising' init replacements such as I. +thought for 'supervising' init replacements such as I. If using +I or I though, starting with version 5.5.0 I is +able to notify these two init replacements, and B require forking to the +background for process supervision. The F directory has sample +I and I configuration files. =item B<-h> @@ -61,7 +72,7 @@ There are two big groups of plugins, B and B plugins: =over 4 -=item +=item * Input plugins are queried periodically. They somehow acquire the current value of whatever they where designed to work with and submit these values back to @@ -69,7 +80,7 @@ the daemon, i. e. they "dispatch" the values. As an example, the C reads the current cpu-counters of time spent in the various modes (user, system, nice, ...) and dispatches these counters to the daemon. -=item +=item * Output plugins get the dispatched values from the daemon and does something with them. Common applications are writing to RRD-files, CSV-files or sending @@ -99,6 +110,25 @@ the daemon, have manpages of their own to describe their functionality in more detail. In particular those are L, L, L, L, and L +=head1 SIGNALS + +B accepts the following signals: + +=over 4 + +=item B, B + +These signals cause B to shut down all plugins and terminate. + +=item B + +This signal causes B to signal all plugins to flush data from +internal caches. E.Eg. the C will write all pending data +to the RRD files. This is the same as using the C command of the +C. + +=back + =head1 SEE ALSO L, @@ -112,6 +142,6 @@ L =head1 AUTHOR -Florian Forster Eocto@verplant.orgE +Florian Forster Eocto@collectd.orgE =cut