Code

t/cibuild.sh, .travis.yml: Do an AddressSanitizer run as well.
[sysdb.git] / doc / sysdbd.conf.5.txt
index 2f38abc8e347a7e141b4f271200b8b3d0f0839c8..6b41dabbab83db5be9ff996a5187affe7e77cadf 100644 (file)
@@ -13,6 +13,8 @@ SYNOPSIS
 --------
   Interval 300
 
+  Listen "unix:/var/run/sysdbd.sock"
+
   LoadPlugin "syslog"
 
   LoadBackend "collectd::unixsock"
@@ -66,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
@@ -82,10 +89,32 @@ 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*
-* *syslog*
+*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/
+
+*syslog*::
+This logging module sends log messages of the daemon and plugins to the local
+system's syslog service.
 
 SEE ALSO
 --------
@@ -97,7 +126,7 @@ sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 
 COPYRIGHT
 ---------
-Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
+Copyright (C) 2012-2013 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