doc/sysdb.1.txt

   1 sysdb(1)
   2 ========
   3 :doctype: manpage
   4
   5 NAME
   6 ----
   7 sysdb - interactive client for the system management and inventory collection
   8 service
   9
  10 SYNOPSIS
  11 --------
  12 *sysdb* ['options']
  13
  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.
  20
  21 OPTIONS
  22 -------
  23 *sysdb* accepts the following command-line options.
  24
  25 Connection options:
  26 ~~~~~~~~~~~~~~~~~~~
  27
  28 *-H* '<host>'::
  29         The SysDB host to connect to. May be specified as the path to a UNIX
  30         socket opened by the daemon. Defaults to {localstatedir}/run/sysdbd.sock.
  31
  32 *-U* '<username>'::
  33         The username used to authenticate against the server. Defaults to the
  34         current user.
  35
  36 *-c* '<command>'::
  37         Send the specified command to the server after authenticating. This option
  38         may be used multiple times. Each command will be send to the server
  39         separately. Exit the process after handling the reply from the last
  40         command.
  41
  42 SSL options:
  43 ~~~~~~~~~~~~
  44
  45 *-K* '<keyfile>'::
  46         The SSL private key file to use for SSL connections.
  47
  48 *-C* '<certfile>'::
  49         The SSL certificate file to use for SSL connections.
  50
  51 *-A* '<cafile>'::
  52         The certificate authority (CA) certificates file for server certificate
  53         verification to use for SSL connection.
  54
  55 General options:
  56 ~~~~~~~~~~~~~~~~
  57
  58 *-h*::
  59         Display a usage and help summary and exit.
  60
  61 *-V*::
  62         Display the version number and copyright information.
  63
  64 AUTHENTICATION
  65 --------------
  66
  67 include::sysdb-auth.txt[]
  68
  69 EXIT CODES
  70 ----------
  71 *0*::
  72         Success.
  73
  74 *1*::
  75         Failure (syntax or usage error). When using the *-c* option, sysdb exits
  76         with status 1 if the specified command failed.
  77
  78 FILES
  79 -----
  80
  81 *~/.config/sysdb/ssl/key.pem*::
  82 *~/.config/sysdb/ssl/cert.pem*::
  83         The default SSL private key and certificate files to use for SSL
  84         connections.
  85
  86 *~/.sysdb_history*::
  87         The command-line history is stored in this file.
  88
  89 BUGS
  90 ----
  91 None known.
  92
  93 SEE ALSO
  94 --------
  95 manpage:sysdbd[1], manpage:sysdbql[7]
  96
  97 The SysDB homepage: https://sysdb.io/
  98
  99 AUTHOR
 100 ------
 101 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 102
 103 COPYRIGHT
 104 ---------
 105 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
 106
 107 This is free software under the terms of the BSD license, see the source for
 108 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
 109 FITNESS FOR A PARTICULAR PURPOSE.
 110
 111 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
 112