commit bdc58f018a4023f0640922da4fb5d282d7615069
parent ba11950f168e73aab72e4ff61683688bfdd7eb7e
Author: Antoine A <>
Date: Tue, 23 Jan 2024 14:48:19 +0100
Update libeufin manpages
Diffstat:
5 files changed, 35 insertions(+), 33 deletions(-)
diff --git a/frags/libeufin-config-cli.rst b/frags/libeufin-config-cli.rst
@@ -19,6 +19,8 @@ It takes two arguments, the section name and the option name
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**-f** \| **--filename**
Interpret value as path with dollar-expansion.
@@ -31,6 +33,8 @@ This command dump the configuration.
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
config pathsub
--------------
@@ -42,4 +46,6 @@ It takes one argument, a path expresion.
**-h** \| **--help**
Print short help on options.
**-c** \| **--config** *FILENAME*
- Specifies the configuration file.
-\ No newline at end of file
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+\ No newline at end of file
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst
@@ -71,8 +71,6 @@ The frequency **may** be specified as
[nexus-submit]
frequency = 5m
- # Optional, but useful to check what Nexus sends to the bank
- submissions_log_directory = $LIBEUFIN_DATA_HOME/uploads
The supported time units are ``s`` (seconds), ``m`` (minutes), ``h`` (hours).
@@ -166,9 +164,6 @@ be stored.
[nexus-postgres]
config = postgres:///nexus
- [nexus-fetch]
- # Optional, but usefull against data loss.
- statement_log_directory = $LIBEUFIN_DATA_HOME/downloads
Assuming that ``$config_file`` contains any required option, the following command
would download any unseen notifications (as camt.054 files).
diff --git a/manpages/libeufin-bank.1.rst b/manpages/libeufin-bank.1.rst
@@ -57,6 +57,8 @@ Its options are as follows:
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**-r** \| **--reset**
If present, deletes any database table (WARNING: potential data loss)
@@ -72,6 +74,8 @@ Its options are as follows:
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
create-account
--------------
@@ -84,6 +88,8 @@ Its options are as follows:
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**-u** \| **--username** *USERNAME*
Account unique username.
**-p** \| **--password** *PASSWORD*
@@ -119,6 +125,8 @@ Its options are as follows:
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**--name** *NAME*
Legal name of the account owner.
**--public** *true|false*
@@ -145,6 +153,8 @@ Its options are as follows:
Print short help on options.
**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
.. include:: ../frags/libeufin-config-cli.rst
diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
@@ -48,9 +48,11 @@ This command creates the client keys, if they aren't found already on the disk,
Its options are as follows:
**-h** \| **--help**
- Prints short help on options.
-**-c** \| **--config** \ \ *FILENAME*
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**--force-keys-resubmission**
Resubmits the client keys. If no keys were found, it creates and submits them.
**--auto-accept-keys**
@@ -68,8 +70,10 @@ Its options are as follows:
**-h** \| **--help**
Print short help on options.
-**-c** \| **--config** \ \ *FILENAME*
+**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
**-r** \| **--reset**
If present, deletes any database table (WARNING: potential data loss)
@@ -83,8 +87,11 @@ Its options are as follows:
**-h** \| **--help**
Print short help on options.
-**-c** \| **--config** \ \ *FILENAME*
+**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+ Uploaded documents will be stored *before* being submitted to the bank. This directory would contain several directories, each named after the ``YYYY-MM-DD/submit`` format. The pain.001 file would then be named in the following schema: ``$microseconds_pain.001.xml``.
**--transient**
This flag, enabled by default, causes the command to check the database and submit only once, and then return.
@@ -96,8 +103,13 @@ This subcommand downloads banking records via EBICS and stores them into the dat
**-h** \| **--help**
Print short help on options.
-**-c** \| **--config** \ \ *FILENAME*
+**-c** \| **--config** *FILENAME*
Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--debug-ebics** *SAVEDIR*
+ Log EBICS content at SAVEDIR.
+ Downloaded documents will be stored *before* being ingested in the database. This directory would contain several directories, each named after the ``YYYY-MM-DD/fetch`` format. The stored files would then be named after the following schema: ``$microseconds_$filename``. Exception to this naming scheme are the HAC responses, since they do not get any filename assigned by the ZIP archive (they are sent unzipped). Their naming scheme is: ``$microseconds_HAC_response.pain.002.xml``.
**--transient**
This flag, enabled by default, causes the command to perform one download and return.
**--pinned-start**
diff --git a/manpages/libeufin-nexus.conf.5.rst b/manpages/libeufin-nexus.conf.5.rst
@@ -156,16 +156,6 @@ FREQUENCY
Duration value to instruct the ``ebics-submit`` subcommand how much to wait
before checking the database again to find new unsubmitted payments.
-SUBMISSIONS_LOG_DIRECTORY
- Optional value to define the path where the pain.001 documents gets stored *before*
- being submitted to the bank. This directory would contain several directories,
- each named after the YYYY-MM-DD format. The pain.001 file would then be named in
- the following schema: ``$submissionTimestampMicroseconds_requestUid_$requestUid_pain.001.xml``.
- ``$requestUid`` is the same value that constitutes the pain.001 ``MsgIg`` element.
- In the event that one log file would be overridden, ``ebics-submit`` fails without
- overriding it.
-
-
EBICS FETCH OPTIONS
-------------------
@@ -175,17 +165,6 @@ FREQUENCY
Duration value to instruct the ``ebics-fetch`` subcommand how often it should
download from the bank.
-STATEMENT_LOG_DIRECTORY
- Optional value to define the path where the downloaded documents would be stored
- *before* being ingested in the database. This directory would contain several
- directories, each named after the YYYY-MM-DD format. The stored files would then
- be named after the following schema:
- ``$downloadTimestampMicroseconds_$filenameAsGivenByTheBank``. In case one log file
- would be overridden, ``ebics-fetch`` fails without overriding it.
- Exception to this naming scheme are the HAC responses, since they do not get any
- filename assigned by the ZIP archive (they are sent unzipped). Their naming scheme
- is: ``$downloadTimestampMicroseconds_HAC_response.pain.002.xml``
-
SEE ALSO
========
