Fix mutex lock in read_event

[collectd.git] / src / collectd-lua.pod

diff --git a/src/collectd-lua.pod b/src/collectd-lua.pod
index 62dd850..eccd71f 100644 (file)
--- a/src/collectd-lua.pod
+++ b/src/collectd-lua.pod
@@ -12,7 +12,7 @@
 
 =head1 NAME
 
-collectd-lua - Documentation of Collectd's C<Lua plugin>
+collectd-lua - Documentation of collectd's C<Lua plugin>
 
 =head1 SYNOPSIS
 
@@ -26,9 +26,9 @@ collectd-lua - Documentation of Collectd's C<Lua plugin>
 
 =head1 DESCRIPTION
 
-The C<Lua plugin> 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<Lua plugin> 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<exec plugin> (see
 L<collectd-exec(5)>) and provides a lot more functionality, too.
 
@@ -56,11 +56,11 @@ If B<BasePath> 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<dispatch functions> which call the appropriate B<callback functions>
 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<callback functions> are implemented in the
 Lua plugin (all of them are optional):
 
@@ -69,11 +69,11 @@ 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<Interval> configuration option of Collectd). Usually
-it will call B<collectd.dispatch_values> to dispatch the values to Collectd
+per interval (see the B<Interval> configuration option of collectd). Usually
+it will call B<collectd.dispatch_values> to dispatch the values to collectd
 which will pass them on to all registered B<write functions>. If this function
-does not return 0 the plugin will be skipped for an increasing
-amount of time until it returns normally again.
+does not return 0, interval between its calls will grow until function returns
+0 again. See the B<MaxReadInterval> configuration option of collectd.
 
 =item write functions
 
@@ -86,14 +86,18 @@ once for every value that was dispatched by any plugin.
 
 The following functions are provided to Lua modules:
 
+=over 4
+
 =item register_read(callback)
 
+Function to register read callbacks.
 The callback will be called without arguments.
 If this callback function does not return 0 the next call will be delayed by
 an increasing interval.
 
-=item register_write
+=item register_write(callback)
 
+Function to register write callbacks.
 The callback function will be called with one argument passed, which will be a
 table of values.
 If this callback function does not return 0 next call will be delayed by
@@ -134,8 +138,8 @@ A very simple write function might look like:
 
 To register those functions with collectd:
 
-  collectd.register_read(read)
-  collectd.register_write(write)
+  collectd.register_read(read)     -- pass function as variable
+  collectd.register_write("write") -- pass by global-scope function name
 
 =back
 
@@ -148,12 +152,12 @@ L<lua(1)>,
 =head1 AUTHOR
 
 The C<Lua plugin> has been written by
-Julien Ammous E<lt>j.ammous<nbsp>atE<nbsp>gmail.comE<gt>,
+Julien Ammous E<lt>j.ammousE<nbsp>atE<nbsp>gmail.comE<gt>,
 Florian Forster E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt> and
-Ruben Kerkhof E<lt>ruben<nbsp>atE<nbsp>rubenkerkhof.com<gt> and
+Ruben Kerkhof E<lt>rubenE<nbsp>atE<nbsp>rubenkerkhof.comE<gt>.
 
 This manpage has been written by Ruben Kerkhof
-E<lt>ruben<nbsp>atE<nbsp>rubenkerkhof.com<gt>.
+E<lt>rubenE<nbsp>atE<nbsp>rubenkerkhof.comE<gt>.
 It is based on the L<collectd-perl(5)> manual page by
 Florian Forster E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt> and
 Sebastian Harl E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.