Code

Added the SysDB homepage to all manpages.
[sysdb.git] / doc / sysdb.1.txt
1 sysdb(1)
2 ========
3 :doctype: manpage
5 NAME
6 ----
7 sysdb - interactive client for the system management and inventory collection
8 service
10 SYNOPSIS
11 --------
12 *sysdb* ['options']
14 DESCRIPTION
15 -----------
16 *sysdb* is a terminal-based, interactive client program for SysDB, a
17 multi-backend system management and inventory collection daemon. It connects
18 to a running daemon and then accepts commands from the user, send them to the
19 server, and display the result.
21 OPTIONS
22 -------
23 *sysdb* accepts the following command-line options.
25 *-H* '<host>'::
26         The SysDB host to connect to. May be specified as the path to a UNIX
27         socket opened by the daemon. Defaults to {localstatedir}/run/sysdbd.sock.
29 *-U* '<username>'::
30         The username used to authenticate against the server. Defaults to the
31         current user.
33 *-c* '<command>'::
34         Send the specified command to the server after authenticating. This option
35         may be used multiple times. Each command will be send to the server
36         separately. Exit the process after handling the reply from the last
37         command.
39 *-h*::
40         Display a usage and help summary and exit.
42 *-V*::
43         Display the version number and copyright information.
45 EXIT CODES
46 ----------
47 *0*::
48         Success.
50 *1*::
51         Failure (syntax or usage error). When using the *-c* option, sysdb exits
52         with status 1 if the specified command failed.
54 BUGS
55 ----
56 None known.
58 SEE ALSO
59 --------
60 manpage:sysdbd[1], manpage:sysdbql[7]
62 The SysDB homepage: http://sysdb.io/
64 AUTHOR
65 ------
66 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
68 COPYRIGHT
69 ---------
70 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
72 This is free software under the terms of the BSD license, see the source for
73 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
74 FITNESS FOR A PARTICULAR PURPOSE.
76 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :