Add some documentation for tokyotyrant to the collectd.conf manpage

[collectd.git] / README

diff --git a/README b/README
index 9cc62ae..83eede2 100644 (file)
--- a/README
+++ b/README
@@ -43,6 +43,9 @@ Features
     - conntrack
       Number of nf_conntrack entries.
 
+    - couchdb
+      Parse statistics from CouchDB JSON documents.
+
     - cpu
       CPU utilization: Time spent in the system, user, nice, idle, and related
       states.
@@ -122,7 +125,7 @@ Features
       using mbmon(1).
 
     - memcachec
-      Query and parse data from a memcache daemon.
+      Query and parse data from a memcache daemon (memcached).
 
     - memcached
       Statistics of the memcached distributed caching system.
@@ -238,6 +241,9 @@ Features
     - thermal
       Linux ACPI thermal zone information.
 
+    - tokyotyrant
+      Record in and file size of a Tokyo Cabinet database file.
+
     - uptime
       System uptime statistics.
 
@@ -539,6 +545,9 @@ Prerequisites
   * libxmms (optional)
     <http://www.xmms.org/>
 
+  * libyajl (optional)
+    Parse JSON data. This is needed for the `couchdb' plugin.
+    <http://www.lloydforge.org/projects/yajl/>
 
 Configuring / Compiling / Installing
 ------------------------------------
@@ -553,10 +562,16 @@ Configuring / Compiling / Installing
   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, 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.
+  dencies for the specified plugin are not met. In that case you can force the
+  plugin to be built using the `--enable-<plugin>=force' configure option.
+  This will most likely fail though unless you're working in a very unusual
+  setup and you really know what you're doing. If you specify the
+  `--disable-<plugin>' configure option, the plugin will not be built. If you
+  specify the `--enable-all-plugins' or `--disable-all-plugins' configure
+  options, all plugins will be enabled or disabled respectively by default.
+  Explicitly enabling or disabling a plugin overwrites the default for the
+  specified plugin. These 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