diff options
| author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-02-24 06:26:10 -0500 |
|---|---|---|
| committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-02-24 06:26:10 -0500 |
| commit | 690853e82d9576b37d69bf4376f729cd6ff26614 (patch) | |
| tree | accb69659722c7fca3ed37cc5bb2950fabeec732 /manpages | |
| parent | 402268ec81c17999c02fe016ffca0a3480e8c5fb (diff) | |
| download | docs-690853e82d9576b37d69bf4376f729cd6ff26614.tar.gz docs-690853e82d9576b37d69bf4376f729cd6ff26614.tar.bz2 docs-690853e82d9576b37d69bf4376f729cd6ff26614.zip | |
document ‘connections’; reorder its subcommands to be roughly in "order of use"
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/libeufin-cli.1.rst | 72 |
1 files changed, 48 insertions, 24 deletions
diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst index 44d8552b..894d9aea 100644 --- a/manpages/libeufin-cli.1.rst +++ b/manpages/libeufin-cli.1.rst @@ -543,60 +543,84 @@ Note that ``--bank-account jrluser`` is the same as in the connections ----------- -WRITEME - -connections download-bank-accounts -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ``connections`` set of commands handle connections between +the bank(s) and Nexus. +It has several subcommands: +new-ebics-connection, +list-connections, +show-connection, +delete-connection, +export-backup, +restore-backup, +get-key-letter, +connect, +list-offered-bank-accounts, +download-bank-accounts, +import-bank-account. + +Generally, you will create a connection, save its critical key information +to a safe location, then use the connection to find and import a bank +account, for further use. + +Several commands take a ``CONNECTION_NAME`` argument. +In the following examples, we use ``conn01`` for that. +Also, for demonstration purposes, we use the sandbox EBICS services, +so the ``EBICS_URL`` follows the previous examples in the ``sandbox`` +command, as the value of environment variable ``LIBEUFIN_SANDBOX_URL`` +suffixed with ``/ebicsweb``, i.e., ``http://localhost:5016/ebicsweb``. + +new-ebics-connection +^^^^^^^^^^^^^^^^^^^^ WRITEME -connections delete-connection -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +list-connections +^^^^^^^^^^^^^^^^ WRITEME -connections connect -^^^^^^^^^^^^^^^^^^^ +show-connection +^^^^^^^^^^^^^^^ WRITEME -connections export-backup -^^^^^^^^^^^^^^^^^^^^^^^^^ +delete-connection +^^^^^^^^^^^^^^^^^ WRITEME -connections get-key-letter -^^^^^^^^^^^^^^^^^^^^^^^^^^ +export-backup +^^^^^^^^^^^^^ WRITEME -connections import-bank-account -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +restore-backup +^^^^^^^^^^^^^^ WRITEME -connections list-connections -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +get-key-letter +^^^^^^^^^^^^^^ WRITEME -connections list-offered-bank-accounts -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +connect +^^^^^^^ WRITEME -connections new-ebics-connection -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +list-offered-bank-accounts +^^^^^^^^^^^^^^^^^^^^^^^^^^ WRITEME -connections restore-backup -^^^^^^^^^^^^^^^^^^^^^^^^^^ +download-bank-accounts +^^^^^^^^^^^^^^^^^^^^^^ WRITEME -connections show-connection -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +import-bank-account +^^^^^^^^^^^^^^^^^^^ WRITEME |