Code

syscollectord: Include extra version information in startup/shutdown messages.
[sysdb.git] / doc / syscollectord.1.txt
1 syscollectord(1)
2 ================
3 Sebastian "tokkee" Harl <sh@tokkee.org>
4 version {package_version}, {build_date}
5 :doctype: manpage
7 NAME
8 ----
9 syscollectord - system management collection service
11 SYNOPSIS
12 --------
13 *syscollectord* ['options']
15 DESCRIPTION
16 -----------
17 *syscollectord* is a multi-backend system management and inventory collection
18 daemon. It may be used to collect information from various backends (e.g.,
19 inventory services, monitoring services, configuration services) and provides
20 a uniform combined view of all data.
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 can be thought of as a database server. All data retrieval,
25 any further processing, storing and exporting of data is done by plugins.
27 OPTIONS
28 -------
29 *syscollectord* accepts the following command-line options.
31 *-C* '<file>'::
32         The main configuration file. This file defines the behavior of
33         *syscollectord* by specifying default settings and the plugins to be
34         loaded.
36 *-d*::
37         Daemonize on startup: Start *syscollectord* as a background process
38         detached from the current terminal and session.
40 *-h*::
41         Display a usage and help summary and exit.
43 *-V*::
44         Display the version number and copyright information.
46 EXIT CODES
47 ----------
48 *0*::
49         Success.
51 *1*::
52         Failure (syntax or usage error).
54 BUGS
55 ----
56 None known.
58 AUTHOR
59 ------
60 syscollectord was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
62 COPYRIGHT
63 ---------
64 Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
66 This is free software under the terms of the BSD license, see the source for
67 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
68 FITNESS FOR A PARTICULAR PURPOSE.
70 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :