Code

Added the SysDB homepage to all manpages.
[sysdb.git] / doc / sysdb.7.txt
1 sysdb(7)
2 ========
3 :doctype: manpage
5 NAME
6 ----
7 sysdb - the System DataBase (SysDB)
9 SYNOPSIS
10 --------
12   sysdbd -C /path/to/sysdbd.conf
14   sysdb -H /path/to/sysdbd.sock
16 DESCRIPTION
17 -----------
18 include::sysdb-description.txt[]
20 SysDB is made up of several components:
22 sysdbd
23 ~~~~~~
24 The SysDB daemon acts as the data collection instance and database server. It
25 collects system and inventory information from the backends and aggregates
26 objects retrieved from different backends based on their attributes. This way,
27 it creates a uniform hierarchy of the entire infrastructure.
29 For details about the SysDB daemon, see its manual page manpage:sysdbd[1].
31 sysdb
32 ~~~~~
33 The SysDB client is a terminal-based, interactive shell which may be used to
34 query the SysDB daemon. It connects to a running daemon and then accepts
35 commands from the user, sends them to the server, and displays the results.
37 For details about the SysDB client, see its manual page manpage:sysdb[1]. For
38 details about how to query the database, see the specification of the SysDB
39 query language in manpage:sysdbql[7].
41 SEE ALSO
42 --------
43 manpage:sysdb[1], manpage:sysdbd[1], manpage:sysdbql[7]
45 The SysDB homepage: http://sysdb.io/
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 :