Code

sysdbd-store-memory(5): Added a manpage for store::memory.
authorSebastian Harl <sh@tokkee.org>
Mon, 10 Aug 2015 07:36:50 +0000 (09:36 +0200)
committerSebastian Harl <sh@tokkee.org>
Mon, 10 Aug 2015 07:36:50 +0000 (09:36 +0200)
doc/Makefile.am
doc/sysdbd-store-memory.5.txt [new file with mode: 0644]

index 915614f..433959f 100644 (file)
@@ -13,6 +13,7 @@ BUILT_SOURCES = \
                sysdbd-facter.5.xml \
                sysdbd-mk-livestatus.5.xml \
                sysdbd-puppet-store-configs.5.xml \
+               sysdbd-store-memory.5.xml \
                sysdbd-store-network.5.xml \
                sysdbd-syslog.5.xml \
                sysdbd-timeseries-rrdtool.5.xml \
@@ -31,6 +32,7 @@ EXTRA_DIST = \
                sysdbd-facter.5.txt \
                sysdbd-mk-livestatus.5.txt \
                sysdbd-puppet-store-configs.5.txt \
+               sysdbd-store-memory.5.txt \
                sysdbd-store-network.5.txt \
                sysdbd-syslog.5.txt \
                sysdbd-timeseries-rrdtool.5.txt \
@@ -45,6 +47,7 @@ CLEANFILES = \
                sysdbd-facter.5 \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
+               sysdbd-store-memory.5 \
                sysdbd-store-network.5 \
                sysdbd-syslog.5 \
                sysdbd-timeseries-rrdtool.5 \
@@ -58,6 +61,7 @@ CLEANFILES = \
                sysdbd-facter.5.html \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
+               sysdbd-store-memory.5.html \
                sysdbd-store-network.5.html \
                sysdbd-syslog.5.html \
                sysdbd-timeseries-rrdtool.5.html \
@@ -71,6 +75,7 @@ CLEANFILES = \
                sysdbd-facter.5.xml \
                sysdbd-mk-livestatus.5.xml \
                sysdbd-puppet-store-configs.5.xml \
+               sysdbd-store-memory.5.xml \
                sysdbd-store-network.5.xml \
                sysdbd-syslog.5.xml \
                sysdbd-timeseries-rrdtool.5.xml \
@@ -86,6 +91,7 @@ man_MANS = \
                sysdbd-facter.5 \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
+               sysdbd-store-memory.5 \
                sysdbd-store-network.5 \
                sysdbd-syslog.5 \
                sysdbd-timeseries-rrdtool.5 \
@@ -101,6 +107,7 @@ html_DATA = \
                sysdbd-facter.5.html \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
+               sysdbd-store-memory.5.html \
                sysdbd-store-network.5.html \
                sysdbd-syslog.5.html \
                sysdbd-timeseries-rrdtool.5.html \
@@ -123,6 +130,7 @@ sysdbd-collectd-unixsock.5.xml: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS)
 sysdbd-facter.5.xml: sysdbd-facter.5.txt $(MAN_DEPS)
 sysdbd-mk-livestatus.5.xml: sysdbd-mk-livestatus.5.txt $(MAN_DEPS)
 sysdbd-puppet-store-configs.5.xml: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS)
+sysdbd-store-memory.5.xml: sysdbd-store-memory.5.txt $(MAN_DEPS)
 sysdbd-store-network.5.xml: sysdbd-store-network.5.txt $(MAN_DEPS)
 sysdbd-syslog.5.xml: sysdbd-syslog.5.txt $(MAN_DEPS)
 sysdbd-timeseries-rrdtool.5.xml: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS)
@@ -137,6 +145,7 @@ sysdbd-collectd-unixsock.5: sysdbd-collectd-unixsock.5.xml
 sysdbd-facter.5: sysdbd-facter.5.xml
 sysdbd-mk-livestatus.5: sysdbd-mk-livestatus.5.xml
 sysdbd-puppet-store-configs.5: sysdbd-puppet-store-configs.5.xml
+sysdbd-store-memory.5: sysdbd-store-memory.5.xml
 sysdbd-store-network.5: sysdbd-store-network.5.xml
 sysdbd-syslog.5: sysdbd-syslog.5.xml
 sysdbd-timeseries-rrdtool.5: sysdbd-timeseries-rrdtool.5.xml
@@ -151,6 +160,7 @@ sysdbd-collectd-unixsock.5.html: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS)
 sysdbd-facter.5.html: sysdbd-facter.5.txt $(MAN_DEPS)
 sysdbd-mk-livestatus.5.html: sysdbd-mk-livestatus.5.txt $(MAN_DEPS)
 sysdbd-puppet-store-configs.5.html: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS)
+sysdbd-store-memory.5.html: sysdbd-store-memory.5.txt $(MAN_DEPS)
 sysdbd-store-network.5.html: sysdbd-store-network.5.txt $(MAN_DEPS)
 sysdbd-syslog.5.html: sysdbd-syslog.5.txt $(MAN_DEPS)
 sysdbd-timeseries-rrdtool.5.html: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS)
diff --git a/doc/sysdbd-store-memory.5.txt b/doc/sysdbd-store-memory.5.txt
new file mode 100644 (file)
index 0000000..ea4afa9
--- /dev/null
@@ -0,0 +1,42 @@
+sysdbd-store-memory(5)
+======================
+:doctype: manpage
+
+NAME
+----
+sysdbd-store-memory - store::memory plugin providing an in-memory store
+
+SYNOPSIS
+--------
+  LoadPlugin "store::memory"
+
+DESCRIPTION
+-----------
+*store::memory* is a plugin which provides an in-memory store for the objects
+(hosts, services) managed by SysDB. As such, its store is volatile and won't
+survive the restart of the daemon.
+
+CONFIGURATION
+-------------
+*store::network* does not accept any configuration options.
+
+SEE ALSO
+--------
+manpage:sysdbd[1], manpage:sysdbd.conf[5]
+
+The SysDB homepage: https://sysdb.io/
+
+AUTHOR
+------
+SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2012-2015 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 :
+