sysdb(7): Added a manpage providing an overview of SysDB.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f605ecfab29233b31fa7c0084b62d98bbf01588c..feae549c17fb0effccc9ad0d622b2ea3dd068595 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -9,6 +9,7 @@ EXTRA_DIST = \
                sysdbd-mk-livestatus.5.txt \
                sysdbd-puppet-store-configs.5.txt \
                sysdbd-syslog.5.txt \
+               sysdb.7.txt \
                sysdbql.7.txt
 CLEANFILES = \
                sysdb.1 \
@@ -19,6 +20,7 @@ CLEANFILES = \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
                sysdbd-syslog.5 \
+               sysdb.7 \
                sysdbql.7 \
                docbook-xsl.css \
                sysdb.1.html \
@@ -29,6 +31,7 @@ CLEANFILES = \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
                sysdbd-syslog.5.html \
+               sysdb.7.html \
                sysdbql.7.html
 
 man_MANS = \
@@ -40,6 +43,7 @@ man_MANS = \
                sysdbd-mk-livestatus.5 \
                sysdbd-puppet-store-configs.5 \
                sysdbd-syslog.5 \
+               sysdb.7 \
                sysdbql.7
 
 html_DATA = \
@@ -52,6 +56,7 @@ html_DATA = \
                sysdbd-mk-livestatus.5.html \
                sysdbd-puppet-store-configs.5.html \
                sysdbd-syslog.5.html \
+               sysdb.7.html \
                sysdbql.7.html
 
 ADOC_ATTRS = -apackage_version=$(PACKAGE_VERSION) \
@@ -66,7 +71,8 @@ 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
-sysdbql.7: sysdbql.7.txt ../version
+sysdb.7: sysdb.7.txt sysdb-description.txt ../version
+sysdbql.7: sysdbql.7.txt sysdb-description.txt ../version
 
 sysdb.1.html: sysdb.1.txt ../version
 sysdbd.1.html: sysdbd.1.txt ../version
@@ -76,7 +82,8 @@ 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
-sysdbql.7.html: sysdbql.7.txt ../version
+sysdb.7.html: sysdb.7.txt sysdb-description.txt ../version
+sysdbql.7.html: sysdbql.7.txt sysdb-description.txt ../version
 
 # This is an ugly hack but fine for now.
 docbook-xsl.css:

diff --git a/doc/sysdb-description.txt b/doc/sysdb-description.txt
new file mode 100644 (file)
index 0000000..64cecf3
--- /dev/null
+++ b/doc/sysdb-description.txt
@@ -0,0 +1,11 @@
+SysDB stores system and inventory information about hardware and software
+systems. This information is stored in a graph-like hierarchy of generic
+objects. The central object type is a host, which generally represents a
+physical or virtual machine or any other type of physical resource. Hosts, in
+turn, may reference a list of services which represent any kind of logical
+resource like a software system. Both, hosts and services, may reference a
+list of attributes which represent further information about the respective
+host or service object. For example, attributes may specify static information
+like a host's architecture or the software version or snapshots of performance
+data like the current memory utilization or much more.
+

diff --git a/doc/sysdb.7.txt b/doc/sysdb.7.txt
new file mode 100644 (file)
index 0000000..325cbca
--- /dev/null
+++ b/doc/sysdb.7.txt
@@ -0,0 +1,60 @@
+sysdb(7)
+========
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdb - the System DataBase (SysDB)
+
+SYNOPSIS
+--------
+
+  sysdbd -C /path/to/sysdbd.conf
+
+  sysdb -H /path/to/sysdbd.sock
+
+DESCRIPTION
+-----------
+include::sysdb-description.txt[]
+
+SysDB is made up of several components:
+
+sysdbd
+~~~~~~
+The SysDB daemon acts as the data collection instance and database server. It
+collects system and inventory information from the backends and aggregates
+objects retrieved from different backends based on their attributes. This way,
+it creates a uniform hierarchy of the entire infrastructure.
+
+For details about the SysDB daemon, see its manual page *sysdbd*(1).
+
+sysdb
+~~~~~
+The SysDB client is a terminal-based, interactive shell which may be used to
+query the SysDB daemon. It connects to a running daemon and then accepts
+commands from the user, sends them to the server, and displays the results.
+
+For details about the SysDB client, see its manual page *sysdb*(1). For
+details about how to query the database, see the specification of the SysDB
+query language in *sysdbql*(7).
+
+SEE ALSO
+--------
+*sysdb*(1), *sysdbd*(1), *sysdbql*(7)
+
+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 :
+

diff --git a/doc/sysdbql.7.txt b/doc/sysdbql.7.txt
index 335918ab59d3473f93f685379b600fe0d51843e6..a6d7314b41844108c4368b10a1e8c584b1a4ae7e 100644 (file)
--- a/doc/sysdbql.7.txt
+++ b/doc/sysdbql.7.txt
@@ -17,16 +17,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-SysDB stores system and inventory information about hardware and software
-systems. This information is stored in a graph-like hierarchy of generic
-objects. The central object type is a host, which generally represents a
-physical or virtual machine or any other type of physical resource. Hosts, in
-turn, may reference a list of services which represent any kind of logical
-resource like a software system. Both, hosts and services, may reference a
-list of attributes which represent further information about the respective
-host or service object. For example, attributes may specify static information
-like a host's architecture or the software version or snapshots of performance
-data like the current memory utilization or much more.
+include::sysdb-description.txt[]
 
 The SysDB query language is a human-readable format for describing a request
 to retrieve data from a SysDB daemon. It is very remotely similar to the