X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-perl.pod;h=5c11b65281cea66df6cf786f102e7abbb363ee0a;hb=3b4201d2235c25ed21174c41c526c9b7894de539;hp=b8d72f06fd8605574acc5f4a5a87cb400252d85e;hpb=fa9fd186f4e09c24a02d9541c2409d21bf282087;p=collectd.git diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod index b8d72f06..5c11b652 100644 --- a/src/collectd-perl.pod +++ b/src/collectd-perl.pod @@ -4,11 +4,13 @@ collectd-perl - Documentation of collectd's C =head1 SYNOPSIS - LoadPlugin perl + + Globals true + # ... IncludeDir "/path/to/perl/plugins" - BaseName "Collectd::Plugin" + BaseName "Collectd::Plugins" EnableDebugger "" LoadPlugin "FooBar" @@ -25,6 +27,12 @@ for collectd in Perl. This is a lot more efficient than executing a Perl-script every time you want to read a value with the C (see L) and provides a lot more functionality, too. +When loading the C, the B option should be enabled. +Else, the perl plugin will fail to load any Perl modules implemented in C, +which includes, amongst many others, the B module used by the plugin +itself. See the documentation of the B option in L +for details. + =head1 CONFIGURATION =over 4 @@ -38,7 +46,9 @@ causes the Perl-interpreter to be initialized. =item B I Prepends IB<::> to all plugin names loaded after this option. This is -provided for convenience to keep plugin names short. +provided for convenience to keep plugin names short. All Perl-based plugins +provided with the I distributions reside in the C +namespace. =item EB IE block @@ -163,7 +173,7 @@ and collectd: =item Config-Item -A config-item is one structure which keeps the informations provided in the +A config-item is one structure which keeps the information provided in the configuration file. The array of children keeps one entry for each configuration option. Each such entry is another config-item structure, which may nest further if nested blocks are used. @@ -713,7 +723,7 @@ types used by the read, write and match functions. =item -Please feel free to send in new plugins to collectd's mailinglist at +Please feel free to send in new plugins to collectd's mailing list at EcollectdEatEverplant.orgE for review and, possibly, inclusion in the main distribution. In the latter case, we will take care of keeping the plugin up to date and adapting it to new versions of collectd.