doc: Added documentation for all existing plugins.

Added one manpage for each plugin.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index ec048b41a7dd2ab2b946e1c3d7d25cd181bb0860..9a5e8249d10a126f49e8e20731863b4b935cccd5 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -12,13 +12,23 @@ CLEANFILES = \
 man_MANS = \
                sysdb.1 \
                sysdbd.1 \
-               sysdbd.conf.5
+               sysdbd.conf.5 \
+               sysdbd-cname-dns.5 \
+               sysdbd-collectd-unixsock.5 \
+               sysdbd-mk-livestatus.5 \
+               sysdbd-puppet-store-configs.5 \
+               sysdbd-syslog.5
 
 html_DATA = \
                docbook-xsl.css \
                sysdb.1.html \
                sysdbd.1.html \
-               sysdbd.conf.5.html
+               sysdbd.conf.5.html \
+               sysdbd-cname-dns.5.html \
+               sysdbd-collectd-unixsock.5.html \
+               sysdbd-mk-livestatus.5.html \
+               sysdbd-puppet-store-configs.5.html \
+               sysdbd-syslog.5.html
 
 ADOC_ATTRS = -apackage_version=$(PACKAGE_VERSION) \
                -abuild_date="$$( date --utc '+%F' )" \
@@ -27,10 +37,20 @@ ADOC_ATTRS = -apackage_version=$(PACKAGE_VERSION) \
 sysdb.1: sysdb.1.txt ../version
 sysdbd.1: sysdbd.1.txt ../version
 sysdbd.conf.5: sysdbd.conf.5.txt ../version
+sysdbd-cname-dns.5: sysdbd-cname-dns.5.txt ../version
+sysdbd-collectd-unixsock.5: sysdbd-collectd-unixsock.5.txt ../version
+sysdbd-mk-livestatus.5: sysdbd-mk-livestatus.5.txt ../version
+sysdbd-puppet-store-configs.5: sysdbd-puppet-store-configs.5.txt ../version
+sysdbd-syslog.5: sysdbd-syslog.5.txt ../version
 
 sysdb.1.html: sysdb.1.txt ../version
 sysdbd.1.html: sysdbd.1.txt ../version
 sysdbd.conf.5.html: sysdbd.conf.5.txt ../version
+sysdbd-cname-dns.5.html: sysdbd-cname-dns.5.txt ../version
+sysdbd-collectd-unixsock.5.html: sysdbd-collectd-unixsock.5.txt ../version
+sysdbd-mk-livestatus.5.html: sysdbd-mk-livestatus.5.txt ../version
+sysdbd-puppet-store-configs.5.html: sysdbd-puppet-store-configs.5.txt ../version
+sysdbd-syslog.5.html: sysdbd-syslog.5.txt ../version
 
 # This is an ugly hack but fine for now.
 docbook-xsl.css:

diff --git a/doc/sysdbd-cname-dns.5.txt b/doc/sysdbd-cname-dns.5.txt
new file mode 100644 (file)
index 0000000..02cd2e1
--- /dev/null
+++ b/doc/sysdbd-cname-dns.5.txt
@@ -0,0 +1,44 @@
+sysdbd-cname-dns(5)
+===================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-cname-dns - cname::dns plugin
+
+SYNOPSIS
+--------
+  LoadPlugin cname::dns
+
+DESCRIPTION
+-----------
+*cname::dns* is a plugin which canonicalizes hostnames based on the canonical
+hostname returned from a reverse DNS query. Each host submitted to SysDB's
+store will be passed through this plugin (if it is loaded) and the
+canonicalized hostname will then be used instead of the hostname submitted by
+the plugin.
+
+CONFIGURATION
+-------------
+*cname::dns* does not currently accept any configuration options.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+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
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+

diff --git a/doc/sysdbd-collectd-unixsock.5.txt b/doc/sysdbd-collectd-unixsock.5.txt
new file mode 100644 (file)
index 0000000..f16ab37
--- /dev/null
+++ b/doc/sysdbd-collectd-unixsock.5.txt
@@ -0,0 +1,62 @@
+sysdbd-collectd-unixsock(5)
+===========================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-collectd-unixsock - collectd::unixsock plugin querying collectd
+
+SYNOPSIS
+--------
+  <LoadBackend "collectd::unixsock">
+      Interval 60
+  </LoadBackend>
+
+  <Backend "collectd::unixsock">
+      <Instance "collector">
+          Socket "/var/run/collectd-unixsock"
+      </Instance>
+  </Backend>
+
+DESCRIPTION
+-----------
+*collectd::unixsock* is a backend module which queries the system statistics
+collection daemon *collectd* using its *unixsock* interface. It connects to
+the daemon and periodically queries all hosts and metric names. The latter are
+then stored as services of the respective host.
+
+CONFIGURATION
+-------------
+*collectd::unixsock* accepts the following configuration options:
+
+*Instance* '<name>'::
+       An instance block specifies a connection to collectd. The specified
+       '<name>' is used to identify the connection internally but otherwise has
+       no special meaning.
+       +
+       An instance block accepts the following configuration options:
+
+       *Socket* '<path>';;
+               The path name of the UNIX domain socket provided by collectd's
+               *unixsock* plugin.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+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
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+

diff --git a/doc/sysdbd-mk-livestatus.5.txt b/doc/sysdbd-mk-livestatus.5.txt
new file mode 100644 (file)
index 0000000..a39c39c
--- /dev/null
+++ b/doc/sysdbd-mk-livestatus.5.txt
@@ -0,0 +1,62 @@
+sysdbd-mk-livestatus(5)
+=======================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-mk-livestatus - mk-livestatus plugin querying monitoring systems
+
+SYNOPSIS
+--------
+  <LoadBackend "mk-livestatus">
+      Interval 300
+  </LoadBackend>
+
+  <Backend "mk-livestatus">
+      <Instance "collector">
+          Socket "/var/lib/nagios4/rw/live"
+      </Instance>
+  </Backend>
+
+DESCRIPTION
+-----------
+*mk-livestatus* is a backend module which queries monitoring systems
+supporting the Check_MK livestatus interface (e.g. Icinga, Naemon, Nagios,
+Shinken). It connects to the monitoring daemon and periodically queries all
+hosts and services.
+
+CONFIGURATION
+-------------
+*mk-livestatus* accepts the following configuration options:
+
+*Instance* '<name>'::
+       An instance block specifies a connection to the monitoring system. The
+       specified '<name>' is used to identify the connection internally but
+       otherwise has no special meaning.
+       +
+       An instance block accepts the following configuration options:
+
+       *Socket* '<path>';;
+               The path name of the UNIX domain socket provided by the livestatus
+               module.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+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
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+

diff --git a/doc/sysdbd-puppet-store-configs.5.txt b/doc/sysdbd-puppet-store-configs.5.txt
new file mode 100644 (file)
index 0000000..fea8fb9
--- /dev/null
+++ b/doc/sysdbd-puppet-store-configs.5.txt
@@ -0,0 +1,75 @@
+sysdbd-puppet-store-configs(5)
+==============================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-puppet-store-configs - puppet::store-configs plugin querying Puppet
+
+SYNOPSIS
+--------
+  <LoadBackend "puppet::store-configs">
+      Interval 300
+  </LoadBackend>
+
+  <Backend "puppet::store-configs">
+      <Connection "puppet">
+          DBAdapter "pgsql"
+          DBName "puppet"
+          DBServer "puppet.domain.tld"
+          DBPort "5432"
+          DBUser "puppet"
+          DBPassword "secret1"
+          DBIOption "name" "value"
+      </Connection>
+  </Backend>
+
+DESCRIPTION
+-----------
+*puppet::store-configs* is a backend module which queries the configuration
+management system *Puppet* using its *store configs* database. It connects to
+the store configs database using a DBI client and periodically queries all
+hosts and facter facts. The hosts are then stored using their fully qualified
+domain names whereas facts are stored as host attributes.
+
+CONFIGURATION
+-------------
+*puppet::store-configs* accepts the following configuration options:
+
+*Connection* '<name>'::
+       A connection block specifies a store configs database to connect to. The
+       specified '<name>' is used to identify the connection internally but
+       otherwise has no special meaning.
+       +
+       A connection block accepts the following configuration options:
+
+       *DBAdapter* '<name>';;
+       *DBName* '<database>';;
+       *DBServer* '<hostname>';;
+       *DBPort* '<port>';;
+       *DBUser* '<username>';;
+       *DBPassword* '<password>';;
+       *DBIOption* '<name>' '<value>';;
+               Connection parameters specifying which database to connect to. Each
+               parameter is passed on to DBI when connecting to the database.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+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
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+

diff --git a/doc/sysdbd-syslog.5.txt b/doc/sysdbd-syslog.5.txt
new file mode 100644 (file)
index 0000000..3709be6
--- /dev/null
+++ b/doc/sysdbd-syslog.5.txt
@@ -0,0 +1,41 @@
+sysdbd-syslog(5)
+================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-syslog - syslog plugin
+
+SYNOPSIS
+--------
+  LoadPlugin syslog
+
+DESCRIPTION
+-----------
+*syslog* is a plugin which connects to the local syslog daemon and forwards
+all log messages to it.
+
+CONFIGURATION
+-------------
+*syslog* does not currently accept any configuration options.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+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
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+

diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt
index e4783ef856d0e2afd5dd30c541db91e466d2892a..1ab438b6e5f775dfb74c27e1b7d8f2b1d68dccf8 100644 (file)
--- a/doc/sysdbd.conf.5.txt
+++ b/doc/sysdbd.conf.5.txt
@@ -97,7 +97,10 @@ 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
@@ -122,6 +125,12 @@ 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.