X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd.pod;h=60707a1de71b3125a1968b55d6d01aeb84a3d1a9;hp=2f7b9f707439c795fcf85acfaede29ec39821a2e;hb=a9e50e9e30ecde17e167e271060c8183bfcbf407;hpb=c1219a1c9db2e8400e2ee94b87f86ccd441485d5 diff --git a/src/collectd.pod b/src/collectd.pod index 2f7b9f70..60707a1d 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -40,16 +40,26 @@ 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 +Specify an alternative pid file. This overwrites any settings in the config file. This is thought for init-scripts that require the PID-file in a certain directory to work correctly. For everyday-usage use the B config-option. +=item B<-B> + +If set, collectd will I try to create its base directory. If the base +directory does not exist, it will exit rather than trying to create the +directory. + =item B<-f> 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> @@ -59,7 +69,7 @@ Output usage information and exit. =head1 PLUGINS -As noted above, the real power of collectd lies within it's plugins. A +As noted above, the real power of collectd lies within its plugins. A (hopefully complete) list of plugins and short descriptions can be found in the F file that is distributed with the sourcecode. If you're using a package it's a good bet to search somewhere near F. @@ -68,7 +78,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 @@ -76,7 +86,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 @@ -138,6 +148,6 @@ L =head1 AUTHOR -Florian Forster Eocto@verplant.orgE +Florian Forster Eocto@collectd.orgE =cut