commit 59b4042e6c254e7b74074b06dfc4bd5d442a0c9a
parent c2b0b6fc3ff00f6ccc814f3b5da33ebc4461c70b
Author: Antoine A <>
Date: Wed, 28 Aug 2024 19:11:50 +0200
libeufin: update man pages
Diffstat:
3 files changed, 84 insertions(+), 71 deletions(-)
diff --git a/frags/libeufin-config-cli.rst b/frags/libeufin-config-cli.rst
@@ -15,26 +15,26 @@ This command lookup config value.
It takes two arguments, the section name and the option name
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
**-f** \| **--filename**
Interpret value as path with dollar-expansion.
+**-h** \| **--help**
+ Print short help on options.
config dump
-----------
This command dump the configuration.
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
+**-h** \| **--help**
+ Print short help on options.
config pathsub
--------------
@@ -43,9 +43,9 @@ This command substitute variables in a path.
It takes one argument, a path expression.
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
+**-h** \| **--help**
+ Print short help on options.
diff --git a/manpages/libeufin-bank.1.rst b/manpages/libeufin-bank.1.rst
@@ -17,8 +17,7 @@ Synopsis
[**--version**]
COMMAND [ARGS...]
-Subcommands: **serve**, **dbinit**, **create-account**, **passwd**, **gc**,
-**config**
+Subcommands: **dbinit**, **passwd**, **serve**, **create-account**, **edit-account**, **gc**, **bench-pwh**, **config**
Description
@@ -50,19 +49,34 @@ The following sections describe each command in detail.
dbinit
------
-This command defines the database schema for LibEuFin Bank. It is mandatory to run this command before invoking the ``serve`` command.
+This command defines the database schema for LibEuFin Bank. It is mandatory to run this command before invoking the ``passwd`` or ``serve`` commands.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
**-r** \| **--reset**
- If present, deletes any database table (WARNING: potential data loss)
+ Reset database (DANGEROUS: All existing data is lost)
+**-h** \| **--help**
+ Print short help on options.
+passwd
+------
+
+This command change any account password.
+
+It takes two arguments, the account username and the account new password.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-h** \| **--help**
+ Print short help on options.
serve
-----
@@ -71,12 +85,12 @@ This command starts the HTTP server.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
- Configure logging to use LOGLEVEL.
+ Configure logging to use LOGLEVEL.
+**-h** \| **--help**
+ Print short help on options.
create-account
--------------
@@ -85,8 +99,6 @@ This command create a bank account and prints its payto://-URI to STDOUT.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
@@ -111,7 +123,12 @@ Its options are as follows:
Payto URI of this account.
**--debit_threshold** *AMOUNT*
Max debit allowed for this account.
-
+**--min_cashout** *AMOUNT*
+ Custom minimum cashout amount for this account.
+**--tan_channel** *TAN_CHANNEL*
+ Enables 2FA and set the TAN channel used for challenges.
+**-h** \| **--help**
+ Print short help on options.
edit-account
--------------
@@ -122,8 +139,6 @@ It takes one argument, the account username.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
@@ -140,36 +155,26 @@ Its options are as follows:
Payto URI of this account.
**--debit_threshold** *AMOUNT*
Max debit allowed for this account.
-
-passwd
-------
-
-This command change any account password.
-
-It takes two arguments, the account username and the account new password.
-
-Its options are as follows:
-
+**--min_cashout** *AMOUNT*
+ Custom minimum cashout amount for this account.
+**--tan_channel** *TAN_CHANNEL*
+ Enables 2FA and set the TAN channel used for challenges.
**-h** \| **--help**
Print short help on options.
-**-c** \| **--config** *config_file*
- Specifies the configuration file.
-**-L** \| **--log** *LOGLEVEL*
- Configure logging to use LOGLEVEL.
gc
--
-This command performs garbage collection: abort expired operations and clean expired data, etc.
+This command performs garbage collection: abort expired operations and clean expired data.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
- Configure logging to use LOGLEVEL.
+ Configure logging to use LOGLEVEL.
+**-h** \| **--help**
+ Print short help on options.
.. include:: ../frags/libeufin-config-cli.rst
diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
@@ -17,7 +17,8 @@ Synopsis
[**--version**]
COMMAND [ARGS...]
-Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**, **config**
+Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**,
+**serve**, **initiate-payment**, **config**
Description
@@ -36,19 +37,42 @@ 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 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.
+- Configure the database with commands ``dbinit``.
+
+- Setup EBICS access with commands ``ebics-setup``. 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.
+
+- Start the HTTP server with command ``serve``.
+ Let this run in a shell, writing logs to stderr.
The following sections describe each command in detail.
+dbinit
+------
+
+This command defines the database schema for LibEuFin Nexus. It is mandatory to run this command before invoking the ``ebics-setup`` or ``serve`` commands.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset database (DANGEROUS: All existing data is lost)
+**-h** \| **--help**
+ Print short help on options.
+
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.
+It is mandatory to run this command before invoking the ``ebics-fetch`` or ``ebics-submit`` commands.
+
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
@@ -61,24 +85,8 @@ Its options are as follows:
Generates the PDF with the client keys fingerprints, if the keys have the submitted state. That's useful in case the PDF went lost after the first submission and the user needs a new PDF.
**--debug-ebics**
Log EBICS transactions steps and payload at log_dir.
-
-
-dbinit
-------
-
-This subcommand defines the database schema for Nexus. It is mandatory to run this command before invoking the ``ebics-submit`` or ``ebics-fetch`` subcommands.
-
-Its options are as follows:
-
**-h** \| **--help**
Print short help on options.
-**-c** \| **--config** *config_file*
- Specifies the configuration file.
-**-L** \| **--log** *LOGLEVEL*
- Configure logging to use LOGLEVEL.
-**-r** \| **--reset**
- Reset database (DANGEROUS: All existing data is lost)
-
ebics-submit
------------
@@ -89,16 +97,16 @@ Submits are executed at 'FREQUENCY'.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
**--transient**
Execute once and return, ignoring the 'FREQUENCY' configuration value.
-**--debug-ebics**
+**--debug-ebics** *log_dir*
Log EBICS transactions steps and payload at log_dir.
+**-h** \| **--help**
+ Print short help on options.
ebics-fetch
-----------
@@ -107,20 +115,20 @@ This subcommand fetches EBICS files from the bank. Incoming payments are recorde
If ACCOUNT_TYPE is ``exchange``, incoming payments with an invalid Taler subject are bounced. Bounces are submitted by ebics-submit.
-Fetches are executed at 'FREQUENCY'.
+Fetches are executed at 'FREQUENCY' or any time a real-time EBICS notification is received.
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
-**--debug-ebics**
- Log EBICS transactions steps and payload at log_dir.
**--transient**
Execute once and return, ignoring the 'FREQUENCY' configuration value.
**--pinned-start** *YYYY-MM-DD*
- Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents.
+ Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents.
+**--debug-ebics** *log_dir*
+ Log EBICS transactions steps and payload at log_dir.
+**-h** \| **--help**
+ Print short help on options.
serve
-----
@@ -129,14 +137,14 @@ This command starts the HTTP server.
Its options are as follows:
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
Configure logging to use LOGLEVEL.
**--check**
Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.
+**-h** \| **--help**
+ Print short help on options.
initiate-payment
----------------
@@ -145,8 +153,6 @@ This subcommand initiates an outgoing payment. The pending payment is stored in
It takes one argument, the creditor IBAN payto URI, which must contain a 'receiver-name' and may contain an 'amount' and a 'message' if they have not been defined using CLI options.
-**-h** \| **--help**
- Print short help on options.
**-c** \| **--config** *config_file*
Specifies the configuration file.
**-L** \| **--log** *LOGLEVEL*
@@ -157,6 +163,8 @@ It takes one argument, the creditor IBAN payto URI, which must contain a 'receiv
The payment subject, payto 'message' parameter takes the precedence
**--request-uid** *TEXT*
The payment request UID, will be randomly generated if missing.
+**-h** \| **--help**
+ Print short help on options.
.. include:: ../frags/libeufin-config-cli.rst
