summaryrefslogtreecommitdiff
path: root/man/libeufin-nexus.1
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2024-04-12 10:33:55 +0200
committerChristian Grothoff <christian@grothoff.org>2024-04-12 10:33:55 +0200
commitb8d2d2fa2ed2a771880f451725176f256583cb22 (patch)
tree5396e6d7a7d886b78df085063fb3d253f1eee182 /man/libeufin-nexus.1
parent8e25124491babb94715edf0b4273ad3b3bb9a6da (diff)
downloaddocs-b8d2d2fa2ed2a771880f451725176f256583cb22.tar.gz
docs-b8d2d2fa2ed2a771880f451725176f256583cb22.tar.bz2
docs-b8d2d2fa2ed2a771880f451725176f256583cb22.zip
-update manpagesprebuilt
Diffstat (limited to 'man/libeufin-nexus.1')
-rw-r--r--man/libeufin-nexus.198
1 files changed, 49 insertions, 49 deletions
diff --git a/man/libeufin-nexus.1 b/man/libeufin-nexus.1
index a4f0d2ac..93aab863 100644
--- a/man/libeufin-nexus.1
+++ b/man/libeufin-nexus.1
@@ -27,15 +27,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "LIBEUFIN-NEXUS" "1" "Mar 07, 2024" "0.9" "GNU Taler"
+.TH "LIBEUFIN-NEXUS" "1" "Apr 12, 2024" "0.9" "GNU Taler"
.SH NAME
libeufin-nexus \- service to interface to various bank access APIs
.SH SYNOPSIS
.sp
\fBlibeufin\-nexus\fP
-[\fB\-h\fP\ |\ \fB\-\-help\fP]
-[\fB\-\-version\fP]
-COMMAND [ARGS...]
+[\fB\-h\fP\ |\ \fB–help\fP]
+[\fB–version\fP]
+COMMAND [ARGS…]
.sp
Subcommands: \fBdbinit\fP, \fBebics\-setup\fP, \fBebics\-submit\fP, \fBebics\-fetch\fP, \fBconfig\fP
.SH DESCRIPTION
@@ -46,7 +46,7 @@ various bank access APIs
Its options are as follows:
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
\fB–version\fP
@@ -60,28 +60,28 @@ In order to operate any EBICS communication with \fBlibeufin\-nexus\fP, it is ne
The following sections describe each command in detail.
.SS ebics\-setup
.sp
-This command creates the client keys, if they aren\(aqt 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.
+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.
.sp
Its options are as follows:
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.TP
-\fB\-\-force\-keys\-resubmission\fP
+\fB–force\-keys\-resubmission\fP
Resubmits the client keys. If no keys were found, it creates and submits them.
.TP
-\fB\-\-auto\-accept\-keys\fP
+\fB–auto\-accept\-keys\fP
Accepts the bank keys without interactively asking the user.
.TP
-\fB\-\-generate\-registration\-pdf\fP
-Generates the PDF with the client keys fingerprints, if the keys have the submitted state. That\(aqs useful in case the PDF went lost after the first submission and the user needs a new PDF.
+\fB–generate\-registration\-pdf\fP
+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.
.UNINDENT
.SS dbinit
.sp
@@ -90,16 +90,16 @@ This subcommand defines the database schema for Nexus. It is mandatory to run t
Its options are as follows:
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.TP
-\fB\-r\fP | \fB\-\-reset\fP
+\fB\-r\fP | \fB–reset\fP
If present, deletes any database table (WARNING: potential data loss)
.UNINDENT
.SS ebics\-submit
@@ -109,17 +109,17 @@ This subcommand submits any initiated payment that was not already sent to the b
Its options are as follows:
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
Uploaded documents will be stored \fIbefore\fP being submitted to the bank. This directory would contain several directories, each named after the \fBYYYY\-MM\-DD/submit\fP format. The pain.001 file would then be named in the following schema: \fB$microseconds_pain.001.xml\fP\&.
.TP
-\fB\-\-transient\fP
+\fB–transient\fP
This flag, enabled by default, causes the command to check the database and submit only once, and then return.
.UNINDENT
.SS ebics\-fetch
@@ -137,48 +137,48 @@ The files type can be given as an argument to select what will be fetched. If no
.UNINDENT
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.TP
-\fB\-\-debug\-ebics\fP \fISAVEDIR\fP
+\fB–debug\-ebics\fP \fISAVEDIR\fP
Log EBICS content at SAVEDIR.
Downloaded documents will be stored \fIbefore\fP being ingested in the database. This directory would contain several directories, each named after the \fBYYYY\-MM\-DD/fetch\fP format. The stored files would then be named after the following schema: \fB$microseconds_$filename\fP\&. 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: \fB$microseconds_HAC_response.pain.002.xml\fP\&.
.TP
-\fB\-\-transient\fP
+\fB–transient\fP
This flag, enabled by default, causes the command to perform one download and return.
.TP
-\fB\-\-pinned\-start\fP
-Only supported in \-\-transient mode, this option lets specify the earliest timestamp of the downloaded documents. The latest timestamp is always the current time.
+\fB–pinned\-start\fP
+Only supported in –transient mode, this option lets specify the earliest timestamp of the downloaded documents. The latest timestamp is always the current time.
.UNINDENT
.SS initiate\-payment
.sp
This subcommand initiates an outgoing payment. The pending payment is stored in the database and will be performed the next time \fBebics\-submit\fP run.
.sp
-It takes one argument, the creditor IBAN payto URI, which must contain a \(aqreceiver\-name\(aq and may contain an \(aqamount\(aq and a \(aqmessage\(aq if they have not been defined using CLI options.
+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.
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.TP
-\fB\-\-amount\fP \fIAMOUNT\fP
-The amount to transfer, payto \(aqamount\(aq parameter takes the precedence
+\fB–amount\fP \fIAMOUNT\fP
+The amount to transfer, payto ‘amount’ parameter takes the precedence
.TP
-\fB\-\-subject\fP \fITEXT\fP
-The payment subject, payto \(aqmessage\(aq parameter takes the precedence
+\fB–subject\fP \fITEXT\fP
+The payment subject, payto ‘message’ parameter takes the precedence
.TP
-\fB\-\-request\-uid\fP \fITEXT\fP
+\fB–request\-uid\fP \fITEXT\fP
The payment request UID, will be randomly generated if missing.
.UNINDENT
.SS config
@@ -186,7 +186,7 @@ The payment request UID, will be randomly generated if missing.
This command inspect or change the configuration.
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.UNINDENT
.sp
@@ -198,16 +198,16 @@ This command lookup config value.
It takes two arguments, the section name and the option name
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.TP
-\fB\-f\fP | \fB\-\-filename\fP
+\fB\-f\fP | \fB–filename\fP
Interpret value as path with dollar\-expansion.
.UNINDENT
.SS config dump
@@ -215,13 +215,13 @@ Interpret value as path with dollar\-expansion.
This command dump the configuration.
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.UNINDENT
.SS config pathsub
@@ -231,13 +231,13 @@ This command substitute variables in a path.
It takes one argument, a path expression.
.INDENT 0.0
.TP
-\fB\-h\fP | \fB\-\-help\fP
+\fB\-h\fP | \fB–help\fP
Print short help on options.
.TP
-\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
+\fB\-c\fP | \fB–config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
-\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP
+\fB\-L\fP | \fB–log\fP \fILOGLEVEL\fP
Configure logging to use LOGLEVEL.
.UNINDENT
.SH SEE ALSO
@@ -249,6 +249,6 @@ Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic mai
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
-2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+2014-2024 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.