From ccc9e40c21915920e9d678ff0fa999302ccd1de4 Mon Sep 17 00:00:00 2001 From: MS Date: Fri, 10 Nov 2023 19:09:25 +0100 Subject: nexus fetch: cli man & manual --- manpages/libeufin-nexus.1.rst | 12 ++++++++---- manpages/libeufin-nexus.conf.5.rst | 12 +++--------- 2 files changed, 11 insertions(+), 13 deletions(-) (limited to 'manpages') diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst index f4df6558..aee26e65 100644 --- a/manpages/libeufin-nexus.1.rst +++ b/manpages/libeufin-nexus.1.rst @@ -89,8 +89,7 @@ Its options are as follows: **-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. + This flag, enabled by default, causes the command to check the database and submit only once, and then return. ebics-fetch ----------- @@ -102,10 +101,15 @@ This subcommands download banking records via EBICS. By default it downloads no **-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. + This flag, enabled by default, causes the command to perform one download and return. **--only-statements** It downloads statements (instead of notifications) in the form of camt.053 documents. +**--only-ack** + It downloads payment submissions acknowledgements (instead of notifications) in the form of pain.002 documents. +**--only-reports** + It downloads only intraday reports (instead of notifications) in the form of camt.052 documents. +**--pinned-start** + Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents. The latest timestamp is always the current time. SEE ALSO diff --git a/manpages/libeufin-nexus.conf.5.rst b/manpages/libeufin-nexus.conf.5.rst index e5a712a8..14161918 100644 --- a/manpages/libeufin-nexus.conf.5.rst +++ b/manpages/libeufin-nexus.conf.5.rst @@ -101,12 +101,8 @@ FREQUENCY Duration value to instruct the ``ebics-submit`` subcommand how much to wait before checking the database again to find new unsubmitted payments. 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 retries 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, whenever - the duration number is zero. Finally, even with a duration number of zero, the - duration unit must be specified. + units are supported: 's' (seconds), 'm' (minutes), 'h' (hours). For example, + the value *5m* causes retries to be run every five minutes. SUBMISSIONS_LOG_DIRECTORY Optional value to define the path where the pain.001 documents would be stored @@ -128,9 +124,7 @@ FREQUENCY 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. + every five minutes. STATEMENT_LOG_DIRECTORY Optional value to define the path where the downloaded documents would be stored -- cgit v1.2.3