sysdb(1), sysdbd(1): Document client authentication.

[sysdb.git] / doc / sysdb.1.txt

diff --git a/doc/sysdb.1.txt b/doc/sysdb.1.txt
index b53a4f0091b1915dee110a493961e81826c3d009..ce73dbe0fe86117320c1e9313a2466b750c3db5c 100644 (file)
--- a/doc/sysdb.1.txt
+++ b/doc/sysdb.1.txt
@@ -1,7 +1,5 @@
 sysdb(1)
 ========
-Sebastian "tokkee" Harl <sh@tokkee.org>
-version {package_version}, {build_date}
 :doctype: manpage
 
 NAME
@@ -24,6 +22,9 @@ OPTIONS
 -------
 *sysdb* accepts the following command-line options.
 
+Connection options:
+~~~~~~~~~~~~~~~~~~~
+
 *-H* '<host>'::
        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.
@@ -38,19 +39,52 @@ OPTIONS
        separately. Exit the process after handling the reply from the last
        command.
 
+SSL options:
+~~~~~~~~~~~~
+
+*-K* '<keyfile>'::
+       The SSL private key file to use for SSL connections.
+
+*-C* '<certfile>'::
+       The SSL certificate file to use for SSL connections.
+
+*-A* '<cafile>'::
+       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
 ----
@@ -58,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 <sh@tokkee.org>.
+SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 
 COPYRIGHT
 ---------