doc/sysdb.1.txt

   1 sysdb(1)
   2 ========
   3 Sebastian "tokkee" Harl <sh@tokkee.org>
   4 version {package_version}, {build_date}
   5 :doctype: manpage
   6
   7 NAME
   8 ----
   9 sysdb - interactive client for the system management and inventory collection
  10 service
  11
  12 SYNOPSIS
  13 --------
  14 *sysdb* ['options']
  15
  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.
  22
  23 OPTIONS
  24 -------
  25 *sysdb* accepts the following command-line options.
  26
  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.
  30
  31 *-U* '<username>'::
  32         The username used to authenticate against the server. Defaults to the
  33         current user.
  34
  35 *-c* '<command>'::
  36         Send the specified command to the server after authenticating. This option
  37         may be used multiple times. Each command will be send to the server
  38         separately. Exit the process after handling the reply from the last
  39         command.
  40
  41 *-h*::
  42         Display a usage and help summary and exit.
  43
  44 *-V*::
  45         Display the version number and copyright information.
  46
  47 EXIT CODES
  48 ----------
  49 *0*::
  50         Success.
  51
  52 *1*::
  53         Failure (syntax or usage error). When using the *-c* option, sysdb exits
  54         with status 1 if the specified command failed.
  55
  56 BUGS
  57 ----
  58 None known.
  59
  60 SEE ALSO
  61 --------
  62 *sysdbd*(1)
  63
  64 AUTHOR
  65 ------
  66 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
  67
  68 COPYRIGHT
  69 ---------
  70 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
  71
  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.
  75
  76 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
  77