summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-08-20 15:46:26 +0200
committerChristian Grothoff <christian@grothoff.org>2021-08-20 15:46:30 +0200
commit4e8169b9d271f7a41f76fc84e0ac26d39ad6c413 (patch)
treedfa919fccccb666413dcb2a4df60856d3ae444e7
parent0a74003538dff631cff4afd77b1f144a3f35a8b8 (diff)
downloadanastasis-4e8169b9d271f7a41f76fc84e0ac26d39ad6c413.tar.gz
anastasis-4e8169b9d271f7a41f76fc84e0ac26d39ad6c413.tar.bz2
anastasis-4e8169b9d271f7a41f76fc84e0ac26d39ad6c413.zip
-update man pages
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/anastasis-config.18
-rw-r--r--doc/anastasis-helper-authorization-iban.178
-rw-r--r--doc/anastasis-httpd.14
-rw-r--r--doc/anastasis-reducer.112
-rw-r--r--doc/anastasis.conf.561
-rw-r--r--doc/sphinx/conf.py3
7 files changed, 142 insertions, 25 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c02adf3..1bdb6d1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,6 +4,7 @@
man_MANS = \
anastasis-httpd.1 \
+ anastasis-helper-authorization-iban.1 \
anastasis-reducer.1 \
anastasis.conf.5 \
anastasis-config.1
diff --git a/doc/anastasis-config.1 b/doc/anastasis-config.1
index bb1512d..b15bbf4 100644
--- a/doc/anastasis-config.1
+++ b/doc/anastasis-config.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "ANASTASIS-CONFIG" "1" "Jul 18, 2021" "0.0" "Anastasis"
+.TH "ANASTASIS-CONFIG" "1" "Aug 20, 2021" "0.0" "Anastasis"
.SH NAME
anastasis-config \- anastasis configuration file manipulation
.
@@ -53,8 +53,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.TP
\fB\-b\fP \fIBACKEND\fP | \fB––supported\-backend=\fP\fIBACKEND\fP
Tests whether the specified \fIBACKEND\fP is supported by the current installation.
-The backend must match the name of a plugin, i.e. “namestore_postgres” for
-the Postgres database backend of the “NAMESTORE” service. If \fIBACKEND\fP is
+The backend must match the name of a plugin, i.e. "namestore_postgres" for
+the Postgres database backend of the "NAMESTORE" service. If \fIBACKEND\fP is
supported, anastasis\-config will return a status code of 0 (success), otherwise
77 (unsupported). When this option is specified, no other options may be
specified. Specifying this option together with other options will cause
@@ -83,7 +83,7 @@ Send logging output to \fIFILENAME\fP\&.
\fB\-o\fP \fIOPTION\fP | \fB––option=\fP\fIOPTION\fP
Which configuration option should be accessed or edited. Required to set a
value. If not given, all values of a given section will be printed in the
-format “OPTION = VALUE”.
+format "OPTION = VALUE".
.TP
\fB\-r\fP | \fB––rewrite\fP
Write the configuration file even if nothing changed. Will remove all comments!
diff --git a/doc/anastasis-helper-authorization-iban.1 b/doc/anastasis-helper-authorization-iban.1
new file mode 100644
index 0000000..3f65af2
--- /dev/null
+++ b/doc/anastasis-helper-authorization-iban.1
@@ -0,0 +1,78 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "ANASTASIS-HELPER-AUTHORIZATION-IBAN" "1" "Aug 20, 2021" "0.0" "Anastasis"
+.SH NAME
+anastasis-helper-authorization-iban \- anastasis IBAN authorization helper
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+\fBanastasis\-helper\-authorization\-iban\fP
+[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP]
+[\fB\-h\fP\ |\ \fB––help\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
+[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
+[\fB\-t\fP\ |\ \fB––test\fP]
+[\fB\-v\fP\ |\ \fB––version\fP]
+.SH DESCRIPTION
+.sp
+\fBanastasis\-helper\-authorization\-iban\fP monitors the Anastasis provider\(aqs bank account for incoming wire transfers. This process supports the IBAN authentication method. It must be configured with the respective wire configuration to talk to LibEuFin/Nexus.
+.INDENT 0.0
+.TP
+\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP
+Use the configuration from \fIFILENAME\fP\&.
+.TP
+\fB\-h\fP | \fB––help\fP
+Print short help on options.
+.TP
+\fB\-L\fP \fILOGLEVEL\fP | \fB––loglevel=\fP‌\fILOGLEVEL\fP
+Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
+\fBWARNING\fP, \fBERROR\fP\&.
+.TP
+\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
+Send logging output to \fIFILENAME\fP\&.
+.TP
+\fB\-t\fP | \fB––test\fP
+Run in test mode. Causes the process to terminate after importing current wire transfers instead of running forever in the background.
+.TP
+\fB\-v\fP | \fB––version\fP
+Print version information.
+.UNINDENT
+.SH SEE ALSO
+.sp
+anastasis\-httpd(1), anastasis.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic
+mail to <\fI\%contact@anastasis.lu\fP>.
+.SH AUTHOR
+Anastasis SARL
+.SH COPYRIGHT
+2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.
diff --git a/doc/anastasis-httpd.1 b/doc/anastasis-httpd.1
index 131be44..27b61c6 100644
--- a/doc/anastasis-httpd.1
+++ b/doc/anastasis-httpd.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "ANASTASIS-HTTPD" "1" "Jul 18, 2021" "0.0" "Anastasis"
+.TH "ANASTASIS-HTTPD" "1" "Aug 20, 2021" "0.0" "Anastasis"
.SH NAME
anastasis-httpd \- anastasis HTTP backend
.
@@ -42,7 +42,7 @@ running this command.
Its options are as follows:
.INDENT 0.0
.TP
-\fB\-C\fP | \fB–connection\-close\fP
+\fB\-C\fP | \fB\-\-connection\-close\fP
Force each HTTP connection to be closed after each request.
.TP
\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP
diff --git a/doc/anastasis-reducer.1 b/doc/anastasis-reducer.1
index 8a79075..c7c4246 100644
--- a/doc/anastasis-reducer.1
+++ b/doc/anastasis-reducer.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "ANASTASIS-REDUCER" "1" "Jul 18, 2021" "0.0" "Anastasis"
+.TH "ANASTASIS-REDUCER" "1" "Aug 20, 2021" "0.0" "Anastasis"
.SH NAME
anastasis-reducer \- anastasis CLI frontend
.
@@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.sp
\fBanastasis\-reducer\fP
-[\fB\-a**_*JSON*_|_\fP–arguments=\fIJSON\fP]
-[\fB\-b**_|_\fP–backup]
+[\fB\-a**_*JSON*_|_\fP\-\-arguments=\fIJSON\fP]
+[\fB\-b**_|_\fP\-\-backup]
[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP]
[\fB\-h\fP\ |\ \fB––help\fP]
[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
-[\fB\-r**_|_\fP–restore]
+[\fB\-r**_|_\fP\-\-restore]
[\fB\-v\fP\ |\ \fB––version\fP] COMMAND
.SH DESCRIPTION
.sp
@@ -56,7 +56,7 @@ chapter.
\fB\-a\fP \fIJSON\fP | \fB––arguments=\fP\fIJSON\fP
Provide JSON inputs for the given command.
.TP
-\fB\-b\fP | \fB–backup\fP
+\fB\-b\fP | \fB\-\-backup\fP
Begin fresh reducer operation for a back up operation.
.TP
\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP
@@ -72,7 +72,7 @@ Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
-\fB\-r\fP | \fB–restore\fP
+\fB\-r\fP | \fB\-\-restore\fP
Begin fresh reducer operation for a restore operation.
.TP
\fB\-v\fP | \fB––version\fP
diff --git a/doc/anastasis.conf.5 b/doc/anastasis.conf.5
index 446531a..e23f7b8 100644
--- a/doc/anastasis.conf.5
+++ b/doc/anastasis.conf.5
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "ANASTASIS.CONF" "5" "Jul 18, 2021" "0.0" "Anastasis"
+.TH "ANASTASIS.CONF" "5" "Aug 20, 2021" "0.0" "Anastasis"
.SH NAME
anastasis.conf \- anastasis configuration file
.
@@ -72,22 +72,18 @@ overrides these defaults.
A configuration file may include another, by using the \fB@INLINE@\fP directive,
for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to
include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&.
-.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1).
+\&.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1).
.SS GLOBAL OPTIONS
.sp
The following options are from the \fB[anastasis]\fP section and used by
the \fBanastasis\-httpd\fP service.
.INDENT 0.0
.TP
-.B PAYMENT_BACKEND_URL
-Base\-URL of the Taler merchant backend instance to use for payments.
-FIXME: How do we pass the access token?
-.TP
.B ANNUAL_FEE
-Annual fee to be paid for policy uploads, i.e. “EUR:1.5”.
+Annual fee to be paid for policy uploads, i.e. "EUR:1.5".
.TP
.B TRUTH_UPLOAD_FEE
-Annual fee to be paid for truth uploads, i.e. “EUR:1.5”.
+Annual fee to be paid for truth uploads, i.e. "EUR:1.5".
.TP
.B DB
Database backend to use, only \fBpostgres\fP is supported right now.
@@ -108,11 +104,25 @@ change after the initial configuration.
.B PORT
TCP port on which the HTTP service should listen on.
.UNINDENT
+.SS Backend options
+.sp
+The following options are from the \fB[anastasis\-merchant\-backend]\fP section and used by
+the \fBanastasis\-httpd\fP service.
+.INDENT 0.0
+.TP
+.B PAYMENT_BACKEND_URL
+Base\-URL of the Taler merchant backend instance to use for payments.
+.TP
+.B API_KEY
+API key to transmit to the merchant backend for authentication.
+.UNINDENT
.SS Authorization options
.sp
-For each active authorization plugin, options must be configured in
-a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is
-the name of the authorization plugin.
+For each active authorization plugin, options must be configured in a
+section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is the
+name of the authorization plugin. Specific plugins may require
+additional options, which are described in the respective sections
+below.
.INDENT 0.0
.TP
.B COST
@@ -121,14 +131,39 @@ authorization plugin during recovery.
.TP
.B ENABLED
\fByes\fP to enable this plugin, \fBno\fP to disable.
+.UNINDENT
+.SS SMS Authorization options
+.INDENT 0.0
.TP
.B COMMAND
-Helper command to run (only relevant for some plugins).
+Helper command to run to send SMS.
+.UNINDENT
+.SS Email Authorization options
+.INDENT 0.0
+.TP
+.B COMMAND
+Helper command to run to send E\-mail.
+.UNINDENT
+.SS Post Authorization options
+.INDENT 0.0
+.TP
+.B COMMAND
+Helper command to run to send physical mail.
+.UNINDENT
+.SS IBAN Authorization options
+.INDENT 0.0
+.TP
+.B CREDIT_IBAN
+IBAN number where the consumers must
+wire the money to for authentication.
+.TP
+.B BUSINESS_NAME
+Name of the account holder.
.UNINDENT
.SS Postgres database configuration
.sp
The following options must be in the section \fB[statis\-postgres]\fP if
-\fBpostgress\fP was used for the database under \fBDB\fP in the
+\fBpostgres\fP was used for the database under \fBDB\fP in the
\fB[anastasis]\fP section.
.INDENT 0.0
.TP
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 098645d..932692b 100644
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -269,6 +269,9 @@ man_pages = [
("manpages/anastasis-reducer.1", "anastasis-reducer",
"anastasis CLI frontend", "Anastasis SARL",
1),
+ ("manpages/anastasis-helper-authorization-iban.1", "anastasis-helper-authorization-iban",
+ "anastasis IBAN authorization helper", "Anastasis SARL",
+ 1),
("manpages/anastasis-config.1", "anastasis-config",
"anastasis configuration file manipulation", "Anastasis SARL",
1),