Added documentation and sample configuration for the facter backend.

[sysdb.git] / doc / sysdbd-facter.5.txt

diff --git a/doc/sysdbd-facter.5.txt b/doc/sysdbd-facter.5.txt
new file mode 100644 (file)
index 0000000..08271d8
--- /dev/null
+++ b/doc/sysdbd-facter.5.txt
@@ -0,0 +1,45 @@
+sysdbd-facter(5)
+================
+:doctype: manpage
+
+NAME
+----
+sysdbd-facter - query local facter fact values
+
+SYNOPSIS
+--------
+  <LoadBackend "facter">
+      Interval 3600
+  </LoadBackend>
+
+DESCRIPTION
+-----------
+*facter* is a backend module which queries facter fact values from the local
+system. It periodically retrieves the values and submits them as host
+attributes.
+
+CONFIGURATION
+-------------
+*facter* does not currently accept any configuration options.
+
+SEE ALSO
+--------
+manpage:sysdbd[1], manpage:sysdbd.conf[5],
+https://github.com/puppetlabs/cfacter
+
+The SysDB homepage: https://sysdb.io/
+
+AUTHOR
+------
+SysDB 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 :
+