[taler-docs] branch master updated: document ‘libeufin-cli connections’ commands

[gnunet]

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

ttn pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 943ed36  document ‘libeufin-cli connections’ commands
943ed36 is described below

commit 943ed36f7212dba0ff6979d1a6fb4330532a9a99
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Sat Feb 26 06:09:24 2022 -0500

    document ‘libeufin-cli connections’ commands
    
    specifically:
    - libeufin-cli connections new-ebics-connection
    - libeufin-cli connections list-connections
    - libeufin-cli connections show-connection
    - libeufin-cli connections delete-connection
    - libeufin-cli connections export-backup
      (but see also: <https://bugs.gnunet.org/view.php?id=7180>)
    
    The other ‘libeufin-cli connections’ commands also hang
    and thus remain undocumented for now.
---
 manpages/libeufin-cli.1.rst | 106 +++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 100 insertions(+), 6 deletions(-)

diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst
index 8a8a8ec..c2300e8 100644
--- a/manpages/libeufin-cli.1.rst
+++ b/manpages/libeufin-cli.1.rst
@@ -572,27 +572,111 @@ suffixed with ``/ebicsweb``, i.e., 
``http://localhost:5016/ebicsweb``.
 new-ebics-connection
 ^^^^^^^^^^^^^^^^^^^^
 
-WRITEME
+The ``connections new-ebics-connection`` command creates a new connection
+between an EBICS service and the Nexus.
+It takes one arg, the ``CONNECTION_NAME``, and four required options:
+
+::
+
+  --ebics-url TEXT      EBICS URL
+  --host-id TEXT        Host ID
+  --partner-id TEXT     Partner ID
+  --ebics-user-id TEXT  Ebics user ID
+
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections new-ebics-connection \
+      --ebics-url http://localhost:5016/ebicsweb \
+      --host-id testhost \
+      --partner-id partner01 \
+      --ebics-user-id user02 \
+      conn01
+
+Note that the ``testhost``, ``partner01``, and ``user02`` are the same as
+in the ``sandbox demobank new-ebicssubscriber`` command (see above).
 
 list-connections
 ^^^^^^^^^^^^^^^^
 
-WRITEME
+The ``connections list-connections`` command lists connections in Nexus.
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections list-connections
+  {
+    "bankConnections" : [ {
+      "name" : "conn01",
+      "type" : "ebics"
+    } ]
+  }
+
+The name of the connection is ``conn01`` as in the
+``connections new-ebics-connection`` example (see above).
 
 show-connection
 ^^^^^^^^^^^^^^^
 
-WRITEME
+The ``connections show-connection`` command displays information
+about a specific connection.
+It takes one argument, the ``CONNECTION_NAME``.
+
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections show-connection conn01
+  {
+    "type" : "ebics",
+    "owner" : "foo",
+    "ready" : true,
+    "details" : {
+      "ebicsUrl" : "http://localhost:5016/ebicsweb";,
+      "ebicsHostId" : "testhost",
+      "partnerId" : "partner01",
+      "userId" : "user02"
+    }
+  }
+
+The details are the same as in the ``connections new-ebics-connections``
+example (see above).
 
 delete-connection
 ^^^^^^^^^^^^^^^^^
 
-WRITEME
+The ``connections delete-connection`` command deletes a bank connection.
+It takes one argument, the ``CONNECTION_NAME``.
+
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections delete-connection conn01
 
 export-backup
 ^^^^^^^^^^^^^
 
-WRITEME
+The ``connections export-backup`` command writes key and signature
+information to a backup file (which you should take care to store
+in a secure location).
+It takes one argument, the ``CONNECTION_NAME`` and two required options:
+
+::
+
+  --passphrase TEXT   Passphrase for locking the backup
+  --output-file TEXT  Where to store the backup
+
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections export-backup \
+      --passphrase secret \
+      --output-file sig-and-key-info \
+      conn01
+  FIXME: Output?  See:  https://bugs.gnunet.org/view.php?id=7180
 
 restore-backup
 ^^^^^^^^^^^^^^
@@ -602,7 +686,17 @@ WRITEME
 get-key-letter
 ^^^^^^^^^^^^^^
 
-WRITEME
+The ``connections get-key-letter`` command creates a PDF file
+that contains key information.
+It takes two arguments, ``CONNECTION_NAME`` and ``OUTPUT_FILE``.
+
+For example:
+
+.. code-block:: console
+
+  $ libeufin-cli connections get-key-letter conn01 key-letter.pdf
+
+This creates file ``key-letter.pdf`` in the current working directory.
 
 connect
 ^^^^^^^

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