summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorMS <ms@taler.net>2023-10-28 11:56:36 +0200
committerMS <ms@taler.net>2023-10-28 11:56:36 +0200
commit9380147fce094c26d76a11f86ae44b064a086cdd (patch)
tree3728526caa6ab6ebca86db7cc62d164cec82892f /manpages
parent3828df4d792d76ec8086874a90e3a76096e69cb8 (diff)
downloaddocs-9380147fce094c26d76a11f86ae44b064a086cdd.tar.gz
docs-9380147fce094c26d76a11f86ae44b064a086cdd.tar.bz2
docs-9380147fce094c26d76a11f86ae44b064a086cdd.zip
ebics-setup manpage
Diffstat (limited to 'manpages')
-rw-r--r--manpages/libeufin-nexus.1.rst22
1 files changed, 21 insertions, 1 deletions
diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
index 1bfb3dcf..253f1b38 100644
--- a/manpages/libeufin-nexus.1.rst
+++ b/manpages/libeufin-nexus.1.rst
@@ -36,10 +36,30 @@ Its options are as follows:
The interaction model is as follows:
-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.
+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 and downloading the bank keys. 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.
+ebics-setup
+-----------
+
+This command creates the client keys, if they aren't found already on the disk, and sends them to the bank if they were not sent yet. In case of sending, it ejects the PDF document that contains the keys fingerprints, so that the user can send it to the bank to confirm their keys. The process continues by checking if the bank keys exist already on disk, and proceeds with downloading them in case they are not. It checks then if the bank keys were accepted by the user; if yes, the setup terminates, otherwise it interactively asks the user to mark the keys as accepted. By accepting the bank keys, the setup terminates successfully.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Prints short help on options.
+**-c** \| **--config** \ ‌\ *FILENAME*
+ Specifies the configuration file.
+**--check-full-config**
+ Checks the configuration of all the three subcommands and returns.
+**--force-keys-resubmission**
+ Resubmits the client keys. If no keys were found, it creates and submits them.
+**--auto-accept-keys**
+ Accepts the bank keys without interactively asking the user.
+**--generate-registration-pdf**
+ Generates the PDF with the client keys fingerprints, even when the keys aren't going to be submitted in the current run. That's useful in case the PDF went lost after the first submission and the user needs a new PDF.
+
dbinit
------