Code

Added sysdb(1) manpage and updated sysdb help output.
[sysdb.git] / doc / sysdb.1.txt
1 sysdb(1)
2 ========
3 Sebastian "tokkee" Harl <sh@tokkee.org>
4 version {package_version}, {build_date}
5 :doctype: manpage
7 NAME
8 ----
9 sysdb - interactive client for the system management and inventory collection
10 service
12 SYNOPSIS
13 --------
14 *sysdb* ['options']
16 DESCRIPTION
17 -----------
18 *sysdb* is a terminal-based, interactive client program for SysDB, a
19 multi-backend system management and inventory collection daemon. It connects
20 to a running daemon and then accepts commands from the user, send them to the
21 server, and display the result.
23 OPTIONS
24 -------
25 *sysdb* accepts the following command-line options.
27 *-H* '<host>'::
28         The SysDB host to connect to. May be specified as the path to a UNIX
29         socket opened by the daemon. Defaults to {localstatedir}/run/sysdbd.sock.
31 *-U* '<username>'::
32         The username used to authenticate against the server. Defaults to the
33         current user.
35 *-h*::
36         Display a usage and help summary and exit.
38 *-V*::
39         Display the version number and copyright information.
41 EXIT CODES
42 ----------
43 *0*::
44         Success.
46 *1*::
47         Failure (syntax or usage error).
49 BUGS
50 ----
51 None known.
53 SEE ALSO
54 --------
55 *sysdbd*(1)
57 AUTHOR
58 ------
59 sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
61 COPYRIGHT
62 ---------
63 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
65 This is free software under the terms of the BSD license, see the source for
66 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
67 FITNESS FOR A PARTICULAR PURPOSE.
69 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :