Code

Unified project description across all documentation.
[sysdb.git] / doc / sysdbd.1.txt
1 sysdbd(1)
2 =========
3 Sebastian "tokkee" Harl <sh@tokkee.org>
4 version {package_version}, {build_date}
5 :doctype: manpage
7 NAME
8 ----
9 sysdbd - system management and inventory collection service
11 SYNOPSIS
12 --------
13 *sysdbd* ['options']
15 DESCRIPTION
16 -----------
17 *sysdbd* is a multi-backend system management and inventory collection daemon.
18 It stores system and inventory information about hardware and software
19 systems. This information is (continuously) collected from various
20 configurable backends.
22 The main daemon itself is the central instance managing all collected
23 information and doing the correlation of objects provided by different
24 backends. It basically acts as a database server. All data retrieval, any
25 further processing, storing and exporting of data is done by plugins.
27 OPTIONS
28 -------
29 *sysdbd* accepts the following command-line options.
31 *-C* '<file>'::
32         The main configuration file. This file defines the behavior of *sysdbd* by
33         specifying default settings and the plugins to be loaded.
35 *-D*::
36         Do not daemonize on startup: Rather than starting *sysdbd* as a background
37         process detached from the current terminal and session (the default), run
38         the process in the foreground. This allows easy monitoring of *sysdbd*.
40 *-h*::
41         Display a usage and help summary and exit.
43 *-V*::
44         Display the version number and copyright information.
46 SIGNALS
47 -------
49 *sysdbd* accepts and handles the following signals:
51 *SIGINT*, *SIGTERM*::
52         These signals initiate a clean shutdown and termination of the daemon.
54 *SIGHUP*::
55         This signal causes the daemon to re-read the configuration and reconfigure
56         all plugins. Plugins which are no longer in use will be disabled and
57         unloaded. Open client connections are not affected by this.
59 EXIT CODES
60 ----------
61 *0*::
62         Success.
64 *1*::
65         Failure (syntax or usage error).
67 BUGS
68 ----
69 None known.
71 SEE ALSO
72 --------
73 *sysdbd.conf*(5)
75 AUTHOR
76 ------
77 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
79 COPYRIGHT
80 ---------
81 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
83 This is free software under the terms of the BSD license, see the source for
84 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
85 FITNESS FOR A PARTICULAR PURPOSE.
87 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :