Code

doc: Added documentation for all existing plugins.
[sysdb.git] / doc / sysdbd-cname-dns.5.txt
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
@@ -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 :
+