plugin: Make sdb_plugin_info_t public.

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

diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt
index 131c75548d05a2e846a6c83f1c92979717652857..5244576cb35ebca13a74075298be97eceb05036d 100644 (file)
--- a/doc/sysdbd.conf.5.txt
+++ b/doc/sysdbd.conf.5.txt
@@ -1,7 +1,5 @@
 sysdbd.conf(5)
 ==============
-Sebastian "tokkee" Harl <sh@tokkee.org>
-version {package_version}, {build_date}
 :doctype: manpage
 
 NAME
@@ -13,6 +11,8 @@ SYNOPSIS
 --------
   Interval 300
 
+  Listen "unix:/var/run/sysdbd.sock"
+
   LoadPlugin "syslog"
 
   LoadBackend "collectd::unixsock"
@@ -66,6 +66,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
@@ -76,11 +81,24 @@ 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.
+with SysDB. See *sysdbd*-'<name>'(5) manpages for more details.
+
+Backends:
+~~~~~~~~~
 
 *collectd::unixsock*::
 This backend module accesses the system statistics collection daemon
@@ -105,21 +123,38 @@ 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
 --------
-*sysdbd*(1)
+manpage:sysdbd[1], manpage:sysdb[7]
+
+Backend documentation:
+~~~~~~~~~~~~~~~~~~~~~~
+
+manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5],
+manpage:sysdbd-puppet-store-configs[5]
+
+Plugin documentation:
+~~~~~~~~~~~~~~~~~~~~~
+
+manpage:sysdbd-cname-dns[5], manpage:sysdbd-syslog[5]
 
 AUTHOR
 ------
-sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 
 COPYRIGHT
 ---------
-Copyright (C) 2012-2013 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