X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=doc%2Fsysdb.1.txt;h=ce73dbe0fe86117320c1e9313a2466b750c3db5c;hp=f2838eb6b230e9927c97b78f3e27429ba4ac81df;hb=2a77f65fe90397f95f6f83fa394e7c1ee304b09e;hpb=d6c02e4e0ff5c234b6b59a4e923d9d7c4fe813e3 diff --git a/doc/sysdb.1.txt b/doc/sysdb.1.txt index f2838eb..ce73dbe 100644 --- a/doc/sysdb.1.txt +++ b/doc/sysdb.1.txt @@ -1,7 +1,5 @@ sysdb(1) ======== -Sebastian "tokkee" Harl -version {package_version}, {build_date} :doctype: manpage NAME @@ -24,6 +22,9 @@ OPTIONS ------- *sysdb* accepts the following command-line options. +Connection options: +~~~~~~~~~~~~~~~~~~~ + *-H* '':: The SysDB host to connect to. May be specified as the path to a UNIX socket opened by the daemon. Defaults to {localstatedir}/run/sysdbd.sock. @@ -32,19 +33,58 @@ OPTIONS The username used to authenticate against the server. Defaults to the current user. +*-c* '':: + Send the specified command to the server after authenticating. This option + may be used multiple times. Each command will be send to the server + separately. Exit the process after handling the reply from the last + command. + +SSL options: +~~~~~~~~~~~~ + +*-K* '':: + The SSL private key file to use for SSL connections. + +*-C* '':: + The SSL certificate file to use for SSL connections. + +*-A* '':: + The certificate authority (CA) certificates file for server certificate + verification to use for SSL connection. + +General options: +~~~~~~~~~~~~~~~~ + *-h*:: Display a usage and help summary and exit. *-V*:: Display the version number and copyright information. +AUTHENTICATION +-------------- + +include::sysdb-auth.txt[] + EXIT CODES ---------- *0*:: Success. *1*:: - Failure (syntax or usage error). + Failure (syntax or usage error). When using the *-c* option, sysdb exits + with status 1 if the specified command failed. + +FILES +----- + +*~/.config/sysdb/ssl/key.pem*:: +*~/.config/sysdb/ssl/cert.pem*:: + The default SSL private key and certificate files to use for SSL + connections. + +*~/.sysdb_history*:: + The command-line history is stored in this file. BUGS ---- @@ -52,11 +92,13 @@ None known. SEE ALSO -------- -*sysdbd*(1) +manpage:sysdbd[1], manpage:sysdbql[7] + +The SysDB homepage: https://sysdb.io/ AUTHOR ------ -sysdbd was written by Sebastian "tokkee" Harl . +SysDB was written by Sebastian "tokkee" Harl . COPYRIGHT ---------