taler-docs

commit e31227e3928308afee7af974acffb4905d57e435
parent 65a9b2dc88c4756f10c8287347d33b01bb1ec9c4
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
Date:   Thu, 27 Jan 2022 04:17:28 -0500

new WIP manpage: libeufin-cli(1)

* manpages/libeufin-cli.1.rst: New.

Diffstat:
A
manpages/libeufin-cli.1.rst
 | 
122
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 122 insertions(+), 0 deletions(-)
diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst
@@ -0,0 +1,122 @@
+libeufin-cli(1)
+###############
+
+.. only:: html
+
+   Name
+   ====
+
+   **libeufin-cli** - Interact with LibEuFin Sandbox and Nexus
+
+
+Synopsis
+========
+
+**libeufin-cli**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Commands: accounts, connections, facades, permissions, sandbox, users
+
+
+Description
+===========
+
+**libeufin-cli** is the user interface program to interact
+with **libeufin-sandbox** and **libeufin-nexus** when they are
+operating as HTTP servers, listening on localhost ports.
+Normally, you invoke them with their respective ``serve`` commands,
+and in a separate shell, use **libeufin-cli** to send requests
+and receive responses from them.
+
+The interaction model is as follows:
+
+- (Optionally) Start the sandbox.
+
+- Start the nexus.
+
+- Use **libeufin-cli** to interact with them.
+  You can manage users and permissions, bank accounts, "facades",
+  transactions, and connections between the various systems.
+
+For **libeufin-cli** to be able to communicate with **libeufin-sandbox**,
+the following environment variables need to be set:
+
+``LIBEUFIN_SANDBOX_USERNAME``
+  This should normally be ``admin``.
+
+``LIBEUFIN_SANDBOX_PASSWORD``
+  This is the same password chosen when the sandbox was started.
+
+``LIBEUFIN_SANDBOX_URL``
+  This is ``http://localhost:PORT/``, where ``PORT`` is the
+  same port chosen when the sandbox was started.
+  This URL can also be specified with the ``--sandbox-url URL``
+  option to the ``sandbox`` command (see below).
+
+For **libeufin-cli** to be able to communicate with **libeufin-nexus**,
+the following environment variables need to be set:
+
+``LIBEUFIN_NEXUS_USERNAME``
+  This is the same username chosen by the nexus ``superuser`` command.
+
+``LIBEUFIN_NEXUS_PASSWORD``
+  This is the same username chosen by the nexus ``superuser`` command.
+
+``LIBEUFIN_NEXUS_URL``
+  This is ``http://localhost:PORT/``, where ``PORT`` is the
+  same port chosen when the nexus was started.
+
+Of the six commands, the ``sandbox`` command talks to the sandbox,
+while the other five commands talk to the nexus.
+The following sections describe each command and their subcommands in detail.
+
+
+sandbox
+-------
+
+WRITEME
+
+
+users
+-----
+
+WRITEME
+
+
+permissions
+-----------
+
+WRITEME
+
+
+accounts
+--------
+
+WRITEME
+
+
+connections
+-----------
+
+WRITEME
+
+
+facades
+-------
+
+WRITEME
+
+
+See Also
+========
+
+.. TODO: libeufin-sandbox(1), libeufin-cli(1).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.