Code

Renamed the project to SysDB (System DataBase).
[sysdb.git] / doc / sysdbd.1.txt
diff --git a/doc/sysdbd.1.txt b/doc/sysdbd.1.txt
new file mode 100644 (file)
index 0000000..33ec8cf
--- /dev/null
@@ -0,0 +1,70 @@
+sysdbd(1)
+=========
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd - system management and inventory collection service
+
+SYNOPSIS
+--------
+*sysdbd* ['options']
+
+DESCRIPTION
+-----------
+*sysdbd* is a multi-backend system management and inventory collection daemon.
+It may be used to (continuously) collect information from various backends
+(e.g., inventory services, monitoring services, configuration services) and
+provides a uniform combined view of all data.
+
+The main daemon itself is the central instance managing all collected
+information and doing the correlation of objects provided by different
+backends. It basically acts as a database server. All data retrieval, any
+further processing, storing and exporting of data is done by plugins.
+
+OPTIONS
+-------
+*sysdbd* accepts the following command-line options.
+
+*-C* '<file>'::
+       The main configuration file. This file defines the behavior of *sysdbd* by
+       specifying default settings and the plugins to be loaded.
+
+*-d*::
+       Daemonize on startup: Start *sysdbd* as a background process detached from
+       the current terminal and session.
+
+*-h*::
+       Display a usage and help summary and exit.
+
+*-V*::
+       Display the version number and copyright information.
+
+EXIT CODES
+----------
+*0*::
+       Success.
+
+*1*::
+       Failure (syntax or usage error).
+
+BUGS
+----
+None known.
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2012 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 :
+