Merge branch 'master' into bp/bind

[collectd.git] / README

diff --git a/README b/README
index a63c71b..9b06f64 100644 (file)
--- a/README
+++ b/README
@@ -146,6 +146,10 @@ Features
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.
 
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.
 

+    - openvpn
+      RX and TX of each client in openvpn-status.log (status-version 2).
+      <http://openvpn.net/index.php/documentation/howto.html>
+

     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this
     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this


@@ -250,6 +254,13 @@ Features
       needed. Please read collectd-unixsock(5) for a description on how that's
       done.
 
       needed. Please read collectd-unixsock(5) for a description on how that's
       done.
 

+  * Filtering and rewriting values dispatched to collectd can be done by the
+    following plugins:
+
+    - filter_pcre
+      Filter and rewrite value lists based on Perl-compatible regular
+      expressions.
+

   * Logging is, as everything in collectd, provided by plugins. The following
     plugins keep up informed about what's going on:
 
   * Logging is, as everything in collectd, provided by plugins. The following
     plugins keep up informed about what's going on:
 


@@ -367,6 +378,7 @@ Prerequisites
 
   * libcurl (optional)
     If you want to use the `apache', `ascent', or `nginx' plugin.
 
   * libcurl (optional)
     If you want to use the `apache', `ascent', or `nginx' plugin.

+    <http://curl.haxx.se/>

 
   * libdbi (optional)
     Used by the `dbi' plugin to connect to various databases.
 
   * libdbi (optional)
     Used by the `dbi' plugin to connect to various databases.


@@ -415,6 +427,10 @@ Prerequisites
     Used to capture packets by the `dns' plugin.
     <http://www.tcpdump.org/>
 
     Used to capture packets by the `dns' plugin.
     <http://www.tcpdump.org/>
 

+  * libpcre (optional)
+    Used by the `filter_pcre' plugin.
+    <http://www.pcre.org/>
+

   * libperl (optional)
     Obviously used by the `perl' plugin. The library has to be compiled with
     ithread support (introduced in Perl 5.6.0).
   * libperl (optional)
     Obviously used by the `perl' plugin. The library has to be compiled with
     ithread support (introduced in Perl 5.6.0).


@@ -471,9 +487,11 @@ Configuring / Compiling / Installing
   disable all plugins whose requirements cannot be fulfilled (any other plugin
   will be enabled). To enable a plugin, install missing dependencies (see
   section `Prerequisites' above) and rerun `configure'. If you specify the
   disable all plugins whose requirements cannot be fulfilled (any other plugin
   will be enabled). To enable a plugin, install missing dependencies (see
   section `Prerequisites' above) and rerun `configure'. If you specify the

-  `--enable-<plugin>' configure option, you can force the plugin to be built.
-  This will most likely fail though unless you're working in a very unusual
-  setup and you really know what you're doing.
+  `--enable-<plugin>' configure option, the script will fail if the depen-
+  dencies for the specified plugin are not met. If you specify the
+  `--disable-<plugin>' configure option, the plugin will not be built. Both
+  options are meant for package maintainers and should not be used in everyday
+  situations.

 
   By default, collectd will be installed into `/opt/collectd'. You can adjust
   this setting by specifying the `--prefix' configure option - see INSTALL for
 
   By default, collectd will be installed into `/opt/collectd'. You can adjust
   this setting by specifying the `--prefix' configure option - see INSTALL for