diff options
author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-01-19 05:12:38 -0500 |
---|---|---|
committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-01-19 05:12:38 -0500 |
commit | bcd5adae13a2f0c94f98dc25c73c6dbcadf7d35d (patch) | |
tree | a5c5b4b8dfc18aacb1297828ee533d7762e8868c | |
parent | b7ab5f85c03fbfb1fa9288211cbf804c76042294 (diff) | |
download | docs-bcd5adae13a2f0c94f98dc25c73c6dbcadf7d35d.tar.gz docs-bcd5adae13a2f0c94f98dc25c73c6dbcadf7d35d.tar.bz2 docs-bcd5adae13a2f0c94f98dc25c73c6dbcadf7d35d.zip |
new WIP manpage: libeufin-sandbox(1)
* manpages/libeufin-sandbox.1.rst: New.
-rw-r--r-- | manpages/libeufin-sandbox.1.rst | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/manpages/libeufin-sandbox.1.rst b/manpages/libeufin-sandbox.1.rst new file mode 100644 index 00000000..b191bbbf --- /dev/null +++ b/manpages/libeufin-sandbox.1.rst @@ -0,0 +1,109 @@ +libeufin-sandbox(1) +################### + +.. only:: html + + Name + ==== + + **libeufin-sandbox** - Simulate a core banking system + with EBICS access to bank accounts + + +Synopsis +======== + +**libeufin-sandbox** +[**-h** | **--help**] +[**--version**] +COMMAND [ARGS...] + +Commands: serve, reset-tables, config, make-transaction, camt053tick +default-exchange + + +Description +=========== + +**libeufin-sandbox** is a program to simulate a core banking system +with EBICS access to bank accounts. +It maintains state in its own private database. +You interact with it through HTTP +requests either over the network or via a Unix domain socket. +Related program **libeufin-cli** is the preferred front end. + +Its options are as follows: + +**-h** \| **--help** + Print short help on options. + +**–version** + Print version information. + +The interaction model is as follows: + +.. @MS Is the order of the first two steps correct? + Or are some of the commands to be used AFTER ‘serve’ starts? + Or is it a mix? (I believe it is a mix, but am not sure.) + +- Configure the sandbox with commands ``default-exchange``, ``config``, + ``make-transaction``, and ``camt053tick``. + +- Start the HTTP server with command ``serve``. + Let this run in a shell, writing logs to stderr. + +- Point program **libeufin-nexus** at the sandbox. + +- Interact with **libeufin-nexus**. + +- When finished, interrupt the ``serve`` process and clean up with command + ``reset-tables``. + +The following sections describe each command in detail. + + +Command ``default-exchange`` +============================ + +.. WRITEME + + +Command ``config`` +================== + +.. WRITEME + + +Command ``make-transaction`` +============================ +.. WRITEME + + +Command ``camt053tick`` +======================= +.. WRITEME + + +Command ``serve`` +================= + +.. WRITEME + + +Command ``reset-tables`` +======================== + +.. WRITEME + + +See Also +======== + +.. TODO: libeufin-nexus(1), libeufin-cli(1). + + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to <taler@gnu.org>. |