From: Ruben Kerkhof Date: Sun, 14 Aug 2016 11:58:14 +0000 (+0200) Subject: Lua plugin: s/Collectd/collectd/g in manpage X-Git-Tag: collectd-5.6.0~33^2~6 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=a70fc1cb6b71b85409c4d8f7e787d95752e3a892;p=collectd.git Lua plugin: s/Collectd/collectd/g in manpage --- diff --git a/src/collectd-lua.pod b/src/collectd-lua.pod index 62dd850e..2f18f60f 100644 --- a/src/collectd-lua.pod +++ b/src/collectd-lua.pod @@ -12,7 +12,7 @@ =head1 NAME -collectd-lua - Documentation of Collectd's C +collectd-lua - Documentation of collectd's C =head1 SYNOPSIS @@ -26,9 +26,9 @@ collectd-lua - Documentation of Collectd's C =head1 DESCRIPTION -The C embeds a Lua interpreter into Collectd and provides an -interface to Collectd's plugin system. This makes it possible to write plugins -for Collectd in Lua. This is a lot more efficient than executing a +The C embeds a Lua interpreter into collectd and provides an +interface to collectd's plugin system. This makes it possible to write plugins +for collectd in Lua. This is a lot more efficient than executing a Lua script every time you want to read a value with the C (see L) and provides a lot more functionality, too. @@ -56,11 +56,11 @@ If B is not specified, this needs to be an absolute path. =head1 WRITING YOUR OWN PLUGINS -Writing your own plugins is quite simple. Collectd manages plugins by means of +Writing your own plugins is quite simple. collectd manages plugins by means of B which call the appropriate B registered by the plugins. Any plugin basically consists of the implementation of these callback functions and initializing code which registers the -functions with Collectd. See the section "EXAMPLES" below for a really basic +functions with collectd. See the section "EXAMPLES" below for a really basic example. The following types of B are implemented in the Lua plugin (all of them are optional): @@ -69,8 +69,8 @@ Lua plugin (all of them are optional): =item read functions These are used to collect the actual data. It is called once -per interval (see the B configuration option of Collectd). Usually -it will call B to dispatch the values to Collectd +per interval (see the B configuration option of collectd). Usually +it will call B to dispatch the values to collectd which will pass them on to all registered B. If this function does not return 0 the plugin will be skipped for an increasing amount of time until it returns normally again.