Code

sysdb(7): Added a manpage providing an overview of SysDB.
[sysdb.git] / doc / sysdb.7.txt
1 sysdb(7)
2 ========
3 Sebastian "tokkee" Harl <sh@tokkee.org>
4 version {package_version}, {build_date}
5 :doctype: manpage
7 NAME
8 ----
9 sysdb - the System DataBase (SysDB)
11 SYNOPSIS
12 --------
14   sysdbd -C /path/to/sysdbd.conf
16   sysdb -H /path/to/sysdbd.sock
18 DESCRIPTION
19 -----------
20 include::sysdb-description.txt[]
22 SysDB is made up of several components:
24 sysdbd
25 ~~~~~~
26 The SysDB daemon acts as the data collection instance and database server. It
27 collects system and inventory information from the backends and aggregates
28 objects retrieved from different backends based on their attributes. This way,
29 it creates a uniform hierarchy of the entire infrastructure.
31 For details about the SysDB daemon, see its manual page *sysdbd*(1).
33 sysdb
34 ~~~~~
35 The SysDB client is a terminal-based, interactive shell which may be used to
36 query the SysDB daemon. It connects to a running daemon and then accepts
37 commands from the user, sends them to the server, and displays the results.
39 For details about the SysDB client, see its manual page *sysdb*(1). For
40 details about how to query the database, see the specification of the SysDB
41 query language in *sysdbql*(7).
43 SEE ALSO
44 --------
45 *sysdb*(1), *sysdbd*(1), *sysdbql*(7)
47 AUTHOR
48 ------
49 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
51 COPYRIGHT
52 ---------
53 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
55 This is free software under the terms of the BSD license, see the source for
56 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
57 FITNESS FOR A PARTICULAR PURPOSE.
59 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :