summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2022-02-03 23:06:01 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2022-02-03 23:06:01 -0500
commitd0db6a210ffedcfa0185bbf7909b3ded9c604c40 (patch)
treed1ce8e278fd4cc5c08239546beddca24a7b710bc /manpages
parent68586bf9b94a7f84c4b9bbe6a07b8beacdf4c666 (diff)
downloaddocs-d0db6a210ffedcfa0185bbf7909b3ded9c604c40.tar.gz
docs-d0db6a210ffedcfa0185bbf7909b3ded9c604c40.tar.bz2
docs-d0db6a210ffedcfa0185bbf7909b3ded9c604c40.zip
add ^^^ headings for sub-sub-commands
Diffstat (limited to 'manpages')
-rw-r--r--manpages/libeufin-cli.1.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst
index fb25c56e..9a1ceb98 100644
--- a/manpages/libeufin-cli.1.rst
+++ b/manpages/libeufin-cli.1.rst
@@ -117,10 +117,16 @@ sandbox ebicshost
The ``ebicshost`` command manages EBICS hosts.
It has two subcommands: create and list.
+sandbox ebicshost create
+^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``ebicshost create`` command creates a EBICS host.
It takes one option, ``--host-id ID``, where ``ID`` is used to
identify that host for all future commands.
+sandbox ebicshost list
+^^^^^^^^^^^^^^^^^^^^^^
+
The ``ebicshost list`` command lists the hosts in the system.
For example:
@@ -142,6 +148,9 @@ sandbox ebicssubscriber
The ``ebicssubscriber`` command manages EBICS subscribers.
It has two subcommands: create and list.
+sandbox ebicssubscriber create
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``ebicssubscriber create`` command creates a EBICS subscriber.
It takes three options, all of which are required:
@@ -184,6 +193,9 @@ The ``ebicsbankaccount`` command manages EBICS bank accounts.
It has one subcommand: create.
(To list accounts, see ``sandbox bankaccount`` below.)
+sandbox ebicsbankaccount
+^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``ebicsbankaccount create`` command takes several options, all required:
::
@@ -227,6 +239,9 @@ The ``bankaccount`` command manages bank accounts.
It has several subcommands: list, generate-transactions,
simulate-incoming-transaction, transactions.
+sandbox bankaccount list
+^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``bankaccount list`` command lists the bank accounts in the system.
For example:
@@ -250,6 +265,9 @@ Note that ``testacct01``, ``DE18500105172929531888``, and ``INGDDEFFXXX``
are the same as specified in the ``ebicsbankaccount create`` example
(see above).
+sandbox bankaccount generate-transactions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The remaining ``bankaccount`` commands deal with transactions
to and from the bank accounts.
@@ -266,6 +284,9 @@ For example:
Note that ``testacct01`` is the account label shown in the ``bankaccount
list`` example (see above).
+sandbox bankaccount simulate-incoming-transaction
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``bankaccount simulate-incoming-transaction`` books an
incoming payment in the sandbox.
It takes one arg, the account label, and several options.
@@ -293,6 +314,9 @@ For example:
Note that ``testacct01`` is the same as in previous examples (see above),
and that ``10.50`` is in ``X.Y`` format.
+sandbox bankaccount transactions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``bankaccount transactions`` command lists transactions.
It takes one arg, the account label.
@@ -384,6 +408,9 @@ In other words:
In the following examples, the base URL will be explicitly shown with
the ``--sandbox-url`` option for the ``demobank`` commands.
+sandbox demobank register
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``demobank register`` command registers a new bank account.
Note that the username will be both the username to login at
the bank and the bank account label.
@@ -402,6 +429,9 @@ For example:
--sandbox-url http://localhost:5016/demobanks/default \
demobank register
+sandbox demobank info
+^^^^^^^^^^^^^^^^^^^^^
+
The ``demobank info`` command returns basic information on a bank account.
It takes option ``--bank-account NAME``.
@@ -423,6 +453,9 @@ For example:
Note that ``jrluser`` is the same username / bank account name
as in the ``register`` example (see above).
+sandbox demobank new-ebicssubscriber
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``demobank new-ebicssubscriber`` command associates a new Ebics
subscriber to an existing bank account.
It takes several options, all required:
@@ -456,6 +489,9 @@ The ``--bank-account jrluser`` is the same as in the
You can see the effect of the ``new-ebicssubscriber`` command
with the ``bankaccount list`` command.
+sandbox demobank new-transaction
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
The ``demobank new-transaction`` command initiates a new transaction.
It takes several options, all required: