[taler-docs] branch master updated: ebics-fetch man pages

[gnunet]

This is an automated email from the git hooks/post-receive script.

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new efa66fb8 ebics-fetch man pages
efa66fb8 is described below

commit efa66fb8f0ce800be81044255ae3282832afeacf
Author: MS <ms@taler.net>
AuthorDate: Fri Nov 10 14:00:07 2023 +0100

    ebics-fetch man pages
---
 manpages/libeufin-nexus.1.rst      | 16 ++++++++++++++++
 manpages/libeufin-nexus.conf.5.rst | 23 ++++++++++++++++++++++-
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
index 181b7927..f4df6558 100644
--- a/manpages/libeufin-nexus.1.rst
+++ b/manpages/libeufin-nexus.1.rst
@@ -92,6 +92,22 @@ Its options are as follows:
    This flag, enabled by default, causes the command to run only once without 
any long-polling behaviour.
    The configuration value FREQUENCY gets therefore ignored.
 
+ebics-fetch
+-----------
+
+This subcommands download banking records via EBICS.  By default it downloads 
notifications, in the form of ``camt.054``.  It looks for the most recent 
incoming transaction and asks the bank any notification starting from such 
timestamp.  Along the download, ebics-fetch would bounce incoming payments that 
do not have a valid Taler subject, or as well those with an already existing 
valid subject.  Valid incoming payments are then stored in the database so that 
they can trigger Taler withd [...]
+
+**-h** \| **--help**
+   Print short help on options.
+**-c** \| **--config** \ ‌\ *FILENAME*
+   Specifies the configuration file.
+**--transient**
+   This flag, enabled by default, causes the command to run only once without 
any long-polling behaviour.
+   The configuration value FREQUENCY gets therefore ignored.
+**--only-statements**
+   It downloads statements (instead of notifications) in the form of camt.053 
documents.
+
+
 SEE ALSO
 ========
 
diff --git a/manpages/libeufin-nexus.conf.5.rst 
b/manpages/libeufin-nexus.conf.5.rst
index 972a6fba..e5a712a8 100644
--- a/manpages/libeufin-nexus.conf.5.rst
+++ b/manpages/libeufin-nexus.conf.5.rst
@@ -47,7 +47,6 @@ LIBEUFIN_HOME
   Home directory of the user, usually “${HOME}”. Can be overwritten by
   testcases by setting ${LIBEUFIN_TEST_HOME}.
 
-
 EBICS SETUP OPTIONS
 -------------------
 
@@ -118,6 +117,28 @@ SUBMISSIONS_LOG_DIRECTORY
   In the event that one log file would be overridden, ``ebics-submit`` fails 
without
   overriding it.
 
+
+EBICS FETCH OPTIONS
+-------------------
+
+The following configuration value(s) belong to the “[nexus-fetch]” section.
+
+FREQUENCY
+  Duration value to instruct the ``ebics-fetch`` subcommand how often it should
+  download from the bank.  The duration must be expressed with a number 
followed
+  by the time unit.  The following time units are supported: 's' (seconds), 'm'
+  (minutes), 'h' (hours).  For example, the value *5m* causes downloads to be 
run
+  every five minutes.  Whenever the given number is zero, the retries are 
long-polled.
+  Note: the current version does NOT support long-polling but would instead 
run in
+  transient mode.  Note: long polling depends also by the bank offering it.
+
+STATEMENT_LOG_DIRECTORY
+  Optional value to define the path where the downloaded documents would be 
stored
+  This directory would contain several directories, each named after the 
YYYY-MM-DD
+  format.  The stored files would then be named in the following schema:
+  ``$downloadTimestampMicroseconds_$filenameAsGivenByTheBank``.  In the event 
that
+  one log file would be overridden, ``ebics-fetch`` fails without overriding 
it.
+
 SEE ALSO
 ========
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.