doc: Added documentation for all existing plugins.

[sysdb.git] / doc / sysdbd.conf.5.txt

diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt
index b389a6c4783ccc4b0ad543623d937d89ff41a650..1ab438b6e5f775dfb74c27e1b7d8f2b1d68dccf8 100644 (file)
--- a/doc/sysdbd.conf.5.txt
+++ b/doc/sysdbd.conf.5.txt
@@ -13,6 +13,10 @@ SYNOPSIS
 --------
   Interval 300
 
+  Listen "unix:/var/run/sysdbd.sock"
+
+  LoadPlugin "syslog"
+
   LoadBackend "collectd::unixsock"
   LoadBackend "mk-livestatus"
 
@@ -64,6 +68,11 @@ GLOBAL SETTINGS
        be used by any "active" backend, that is, those that actively query some
        external system rather than receiving some stream of events.
 
+*Listen* '<socket>'::
+       Sets the address on which sysdbd is to listen for client connections. It
+       supports UNIX domain sockets. The path name needs to be prefixed by
+       'unix:'.
+
 *LoadBackend* '<name>'::
        Loads the backend named '<name>'. Backends are special plugins taking care
        of collecting values from external systems. This may optionally be a
@@ -74,15 +83,57 @@ GLOBAL SETTINGS
                be used for this backend. See the global *Interval* option for more
                details.
 
+*LoadPlugin* '<name>'::
+       Loads the plugin named '<name>'. Plugins provide additional functionality
+       for sysdbd.
+
+*PluginDir* '<directory>'::
+       Sets the base directory for plugins to '<directory>'. When loading a
+       plugin, it is expected to be found below this directory. This option
+       affects all following *LoadBackend* or *LoadPlugin* statements up to the
+       following *PluginDir* option.
+
 PLUGINS
 -------
 Some plugins support additional configuration options. Each of these are
 enclosed in a *Plugin* or *Backend* section. The following plugins are shipped
-with SysDB. See *sysdb*-'<name>'(5) manpages for more details.
-
-* *collectd::unixsock*
-* *mk-livestatus*
-* *puppet::store-configs*
+with SysDB. See *sysdbd*-'<name>'(5) manpages for more details.
+
+Backends:
+~~~~~~~~~
+
+*collectd::unixsock*::
+This backend module accesses the system statistics collection daemon
+*collectd* through its UNIX socket interface. It periodically queries all host
+and service information.
++
+See also: http://collectd.org
+
+*mk-livestatus*::
+This backend modules accesses monitoring systems supporting the *livestatus*
+addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all
+host and service information.
++
+See also: http://mathias-kettner.de/checkmk_livestatus.html,
+http://www.nagios.org/, http://icinga.org/, http://www.shinken-monitoring.org/
+
+*puppet::store-configs*::
+This backend module accesses the configuration management system *Puppet*
+through its *store configs* database. It periodically queries all host and
+facter facts information storing the latter as host attributes.
++
+See also: http://puppetlabs.com/puppet,
+http://puppetlabs.com/puppet/related-projects/facter/
+
+Plugins:
+~~~~~~~~
+
+*cname::dns*::
+Canonicalize hostnames based on a reverse DNS query.
+
+*syslog*::
+This logging module sends log messages of the daemon and plugins to the local
+system's syslog service.
 
 SEE ALSO
 --------
@@ -94,7 +145,7 @@ sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 
 COPYRIGHT
 ---------
-Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
+Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
 
 This is free software under the terms of the BSD license, see the source for
 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or