[taler-docs] branch master updated: nexus dbinit manpage

[gnunet]

This is an automated email from the git hooks/post-receive script.

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 2ef6141a nexus dbinit manpage
2ef6141a is described below

commit 2ef6141a0c47f87d5c9d08d13c2e3bd4f7830b0a
Author: MS <ms@taler.net>
AuthorDate: Tue Oct 24 17:40:47 2023 +0200

    nexus dbinit manpage
---
 manpages/libeufin-nexus.1.rst | 119 ++++++------------------------------------
 1 file changed, 15 insertions(+), 104 deletions(-)

diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
index 792c1de6..1bfb3dcf 100644
--- a/manpages/libeufin-nexus.1.rst
+++ b/manpages/libeufin-nexus.1.rst
@@ -6,7 +6,7 @@ libeufin-nexus(1)
    Name
    ====
 
-   **libeufin-nexus** - Service to interface to various bank access APIs
+   **libeufin-nexus** - EBICS client.
 
 
 Synopsis
@@ -17,21 +17,14 @@ Synopsis
 [**--version**]
 COMMAND [ARGS...]
 
-Commands: serve, superuser, parse-camt, reset-tables
+Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**
 
 
 Description
 ===========
 
 **libeufin-nexus** is a program that provides a service to interface to
-various bank access APIs, using JSON as the response format.
-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
-for that mode of operation.
-There is also a mode where **libeufin-nexus** accepts commands directly,
-useful for doing administrative tasks.
+various bank access APIs
 
 Its options are as follows:
 
@@ -43,108 +36,26 @@ Its options are as follows:
 
 The interaction model is as follows:
 
-- Configure the nexus with command ``superuser``.
-
-- Start the HTTP server with command ``serve``.
-  Let this run in a shell, writing logs to stderr.
-
-- Interact with **libeufin-nexus**.
-
-- When finished, interrupt the ``serve`` process and clean up with command
-  ``reset-tables``.
+In order to operate any EBICS communication with ``libeufin-nexus``, it is 
necessary to setup EBICS access via the ``ebics-setup`` subcommand.  Setting 
the access means to share the client keys with the bank, downloading the bank 
keys, and obtaining some basic information about the bank account that is 
associated to the client.  After a successful setup, the subcommands 
``ebics-submit`` and ``ebics-fetch`` can be run to respectively send payments 
and download the bank account history.
 
 The following sections describe each command in detail.
 
 
-superuser
----------
-
-This command adds a superuser, or changes the password.
-It takes argument ``USERNAME``.
-Option ``--password TEXT`` specifies the password.
-If omitted, **libeufin-nexus** will query interactively for it.
-
-For example:
-
-.. code-block:: console
-
-  $ libeufin-nexus superuser joe
-
-This creates superuser ``joe`` and interactively queries for the password.
-
-
-parse-camt
-----------
-
-This command parses a camt file and displays the result to stdout.
-It takes argument ``FILENAME``, which names a file in CAMT format.
-Parsing may also display log information to stderr.
-The normal log level is ``DEBUG``.
-To change it, use ``--log-level LEVEL``, where ``LEVEL`` is one of:
-``ERROR``, ``WARN``, ``INFO``, ``DEBUG``, ``TRACE``.
-
-For example:
-
-.. code-block:: console
-
-  $ libeufin-nexus parse-camt camt53-gls-style-0.xml
-  {
-    "transactions" : [ {
-      "amount" : "EUR:2.35",
-      "creditDebitIndicator" : "DBIT",
-      ...
-    } ]
-  }
-
-
-serve
------
+dbinit
+------
 
-This command starts the HTTP server, listening on port 5001.
-To use a different port, use option ``--port INT``.
-To listen, instead, on a Unix domain socket,
-use option ``--with-unix-socket PATH``.
-When both ``--port`` and ``--with-unix-socket`` are given,
-``--with-unix-socket`` takes precedence.
+This subcommand defines the database schema for Nexus.  It is mandatory to run 
this command before invoking the ``ebics-submit`` or ``ebics-fetch`` 
subcommands.
 
-The process runs in the foreground, writing its logs to standard error.
-The normal log level is ``DEBUG``.
-To change it, use ``--log-level LEVEL``, where ``LEVEL`` is one of:
-``ERROR``, ``WARN``, ``INFO``, ``DEBUG``, ``TRACE``.
-
-Before invoking ``serve``, the following environment variable needs to be set:
-
-``LIBEUFIN_NEXUS_DB_CONNECTION``
-   This specifies the database **libeufin-nexus** uses to maintain state.
-   Currently, both Sqlite and PostgreSQL are supported.
-   (Only one needs to be specified.)
-   Examples:
-
-   - ``jdbc:sqlite:/tmp/libeufin-nexus.db``
-   - ``jdbc:postgresql://localhost:5432/libeufindb?user=Foo&password=secret``
-
-Normally, the ``serve`` command runs until interrupted.
-When run in a shell, you can use ``Control-C`` for that.
-
-
-reset-tables
-------------
-
-This command drops all the tables in the internal database.
-(The next time the tables are needed, **libeufin-nexus** creates them
-again, automatically.)
-
-It should only be used when the nexus is quiescent.
-
-
-See Also
-========
-
-.. TODO: libeufin-sandbox(1), libeufin-cli(1).
+Its options are as follows:
 
+**-h** \| **--help**
+   Print short help on options.
+**-c** \| **--config** \ ‌\ *FILENAME*
+   Specifies the configuration file.
+**-r** \| **--reset**
+   If present, deletes any database table (WARNING: potential data loss)
 
 Bugs
 ====
 
-Report bugs by using https://bugs.taler.net or by sending electronic
-mail to <taler@gnu.org>.
+Report bugs by using https://bugs.taler.net or by sending electronic mail to 
<taler@gnu.org>.

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.