aboutsummaryrefslogtreecommitdiff
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.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 @@
4 4
5man_MANS = \ 5man_MANS = \
6 anastasis-httpd.1 \ 6 anastasis-httpd.1 \
7 anastasis-helper-authorization-iban.1 \
7 anastasis-reducer.1 \ 8 anastasis-reducer.1 \
8 anastasis.conf.5 \ 9 anastasis.conf.5 \
9 anastasis-config.1 10 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 @@
1.\" Man page generated from reStructuredText. 1.\" Man page generated from reStructuredText.
2. 2.
3.TH "ANASTASIS-CONFIG" "1" "Jul 18, 2021" "0.0" "Anastasis" 3.TH "ANASTASIS-CONFIG" "1" "Aug 20, 2021" "0.0" "Anastasis"
4.SH NAME 4.SH NAME
5anastasis-config \- anastasis configuration file manipulation 5anastasis-config \- anastasis configuration file manipulation
6. 6.
@@ -53,8 +53,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
53.TP 53.TP
54\fB\-b\fP \fIBACKEND\fP | \fB––supported\-backend=\fP\fIBACKEND\fP 54\fB\-b\fP \fIBACKEND\fP | \fB––supported\-backend=\fP\fIBACKEND\fP
55Tests whether the specified \fIBACKEND\fP is supported by the current installation. 55Tests whether the specified \fIBACKEND\fP is supported by the current installation.
56The backend must match the name of a plugin, i.e. namestore_postgres for 56The backend must match the name of a plugin, i.e. "namestore_postgres" for
57the Postgres database backend of the NAMESTORE service. If \fIBACKEND\fP is 57the Postgres database backend of the "NAMESTORE" service. If \fIBACKEND\fP is
58supported, anastasis\-config will return a status code of 0 (success), otherwise 58supported, anastasis\-config will return a status code of 0 (success), otherwise
5977 (unsupported). When this option is specified, no other options may be 5977 (unsupported). When this option is specified, no other options may be
60specified. Specifying this option together with other options will cause 60specified. Specifying this option together with other options will cause
@@ -83,7 +83,7 @@ Send logging output to \fIFILENAME\fP\&.
83\fB\-o\fP \fIOPTION\fP | \fB––option=\fP\fIOPTION\fP 83\fB\-o\fP \fIOPTION\fP | \fB––option=\fP\fIOPTION\fP
84Which configuration option should be accessed or edited. Required to set a 84Which configuration option should be accessed or edited. Required to set a
85value. If not given, all values of a given section will be printed in the 85value. If not given, all values of a given section will be printed in the
86format OPTION = VALUE. 86format "OPTION = VALUE".
87.TP 87.TP
88\fB\-r\fP | \fB––rewrite\fP 88\fB\-r\fP | \fB––rewrite\fP
89Write the configuration file even if nothing changed. Will remove all comments! 89Write 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 @@
1.\" Man page generated from reStructuredText.
2.
3.TH "ANASTASIS-HELPER-AUTHORIZATION-IBAN" "1" "Aug 20, 2021" "0.0" "Anastasis"
4.SH NAME
5anastasis-helper-authorization-iban \- anastasis IBAN authorization helper
6.
7.nr rst2man-indent-level 0
8.
9.de1 rstReportMargin
10\\$1 \\n[an-margin]
11level \\n[rst2man-indent-level]
12level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13-
14\\n[rst2man-indent0]
15\\n[rst2man-indent1]
16\\n[rst2man-indent2]
17..
18.de1 INDENT
19.\" .rstReportMargin pre:
20. RS \\$1
21. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22. nr rst2man-indent-level +1
23.\" .rstReportMargin post:
24..
25.de UNINDENT
26. RE
27.\" indent \\n[an-margin]
28.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29.nr rst2man-indent-level -1
30.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32..
33.SH SYNOPSIS
34.sp
35\fBanastasis\-helper\-authorization\-iban\fP
36[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP]
37[\fB\-h\fP\ |\ \fB––help\fP]
38[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
39[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
40[\fB\-t\fP\ |\ \fB––test\fP]
41[\fB\-v\fP\ |\ \fB––version\fP]
42.SH DESCRIPTION
43.sp
44\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.
45.INDENT 0.0
46.TP
47\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP
48Use the configuration from \fIFILENAME\fP\&.
49.TP
50\fB\-h\fP | \fB––help\fP
51Print short help on options.
52.TP
53\fB\-L\fP \fILOGLEVEL\fP | \fB––loglevel=\fP‌\fILOGLEVEL\fP
54Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
55\fBWARNING\fP, \fBERROR\fP\&.
56.TP
57\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
58Send logging output to \fIFILENAME\fP\&.
59.TP
60\fB\-t\fP | \fB––test\fP
61Run in test mode. Causes the process to terminate after importing current wire transfers instead of running forever in the background.
62.TP
63\fB\-v\fP | \fB––version\fP
64Print version information.
65.UNINDENT
66.SH SEE ALSO
67.sp
68anastasis\-httpd(1), anastasis.conf(5).
69.SH BUGS
70.sp
71Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic
72mail to <\fI\%contact@anastasis.lu\fP>.
73.SH AUTHOR
74Anastasis SARL
75.SH COPYRIGHT
762020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+)
77.\" Generated by docutils manpage writer.
78.
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 @@
1.\" Man page generated from reStructuredText. 1.\" Man page generated from reStructuredText.
2. 2.
3.TH "ANASTASIS-HTTPD" "1" "Jul 18, 2021" "0.0" "Anastasis" 3.TH "ANASTASIS-HTTPD" "1" "Aug 20, 2021" "0.0" "Anastasis"
4.SH NAME 4.SH NAME
5anastasis-httpd \- anastasis HTTP backend 5anastasis-httpd \- anastasis HTTP backend
6. 6.
@@ -42,7 +42,7 @@ running this command.
42Its options are as follows: 42Its options are as follows:
43.INDENT 0.0 43.INDENT 0.0
44.TP 44.TP
45\fB\-C\fP | \fBconnection\-close\fP 45\fB\-C\fP | \fB\-\-connection\-close\fP
46Force each HTTP connection to be closed after each request. 46Force each HTTP connection to be closed after each request.
47.TP 47.TP
48\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP 48\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 @@
1.\" Man page generated from reStructuredText. 1.\" Man page generated from reStructuredText.
2. 2.
3.TH "ANASTASIS-REDUCER" "1" "Jul 18, 2021" "0.0" "Anastasis" 3.TH "ANASTASIS-REDUCER" "1" "Aug 20, 2021" "0.0" "Anastasis"
4.SH NAME 4.SH NAME
5anastasis-reducer \- anastasis CLI frontend 5anastasis-reducer \- anastasis CLI frontend
6. 6.
@@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
33.SH SYNOPSIS 33.SH SYNOPSIS
34.sp 34.sp
35\fBanastasis\-reducer\fP 35\fBanastasis\-reducer\fP
36[\fB\-a**_*JSON*_|_\fParguments=\fIJSON\fP] 36[\fB\-a**_*JSON*_|_\fP\-\-arguments=\fIJSON\fP]
37[\fB\-b**_|_\fPbackup] 37[\fB\-b**_|_\fP\-\-backup]
38[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP] 38[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP]
39[\fB\-h\fP\ |\ \fB––help\fP] 39[\fB\-h\fP\ |\ \fB––help\fP]
40[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP] 40[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
41[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP] 41[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
42[\fB\-r**_|_\fPrestore] 42[\fB\-r**_|_\fP\-\-restore]
43[\fB\-v\fP\ |\ \fB––version\fP] COMMAND 43[\fB\-v\fP\ |\ \fB––version\fP] COMMAND
44.SH DESCRIPTION 44.SH DESCRIPTION
45.sp 45.sp
@@ -56,7 +56,7 @@ chapter.
56\fB\-a\fP \fIJSON\fP | \fB––arguments=\fP\fIJSON\fP 56\fB\-a\fP \fIJSON\fP | \fB––arguments=\fP\fIJSON\fP
57Provide JSON inputs for the given command. 57Provide JSON inputs for the given command.
58.TP 58.TP
59\fB\-b\fP | \fBbackup\fP 59\fB\-b\fP | \fB\-\-backup\fP
60Begin fresh reducer operation for a back up operation. 60Begin fresh reducer operation for a back up operation.
61.TP 61.TP
62\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP 62\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,
72\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP 72\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
73Send logging output to \fIFILENAME\fP\&. 73Send logging output to \fIFILENAME\fP\&.
74.TP 74.TP
75\fB\-r\fP | \fBrestore\fP 75\fB\-r\fP | \fB\-\-restore\fP
76Begin fresh reducer operation for a restore operation. 76Begin fresh reducer operation for a restore operation.
77.TP 77.TP
78\fB\-v\fP | \fB––version\fP 78\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 @@
1.\" Man page generated from reStructuredText. 1.\" Man page generated from reStructuredText.
2. 2.
3.TH "ANASTASIS.CONF" "5" "Jul 18, 2021" "0.0" "Anastasis" 3.TH "ANASTASIS.CONF" "5" "Aug 20, 2021" "0.0" "Anastasis"
4.SH NAME 4.SH NAME
5anastasis.conf \- anastasis configuration file 5anastasis.conf \- anastasis configuration file
6. 6.
@@ -72,22 +72,18 @@ overrides these defaults.
72A configuration file may include another, by using the \fB@INLINE@\fP directive, 72A configuration file may include another, by using the \fB@INLINE@\fP directive,
73for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to 73for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to
74include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&. 74include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&.
75.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1). 75\&.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1).
76.SS GLOBAL OPTIONS 76.SS GLOBAL OPTIONS
77.sp 77.sp
78The following options are from the \fB[anastasis]\fP section and used by 78The following options are from the \fB[anastasis]\fP section and used by
79the \fBanastasis\-httpd\fP service. 79the \fBanastasis\-httpd\fP service.
80.INDENT 0.0 80.INDENT 0.0
81.TP 81.TP
82.B PAYMENT_BACKEND_URL
83Base\-URL of the Taler merchant backend instance to use for payments.
84FIXME: How do we pass the access token?
85.TP
86.B ANNUAL_FEE 82.B ANNUAL_FEE
87Annual fee to be paid for policy uploads, i.e. EUR:1.5. 83Annual fee to be paid for policy uploads, i.e. "EUR:1.5".
88.TP 84.TP
89.B TRUTH_UPLOAD_FEE 85.B TRUTH_UPLOAD_FEE
90Annual fee to be paid for truth uploads, i.e. EUR:1.5. 86Annual fee to be paid for truth uploads, i.e. "EUR:1.5".
91.TP 87.TP
92.B DB 88.B DB
93Database backend to use, only \fBpostgres\fP is supported right now. 89Database backend to use, only \fBpostgres\fP is supported right now.
@@ -108,11 +104,25 @@ change after the initial configuration.
108.B PORT 104.B PORT
109TCP port on which the HTTP service should listen on. 105TCP port on which the HTTP service should listen on.
110.UNINDENT 106.UNINDENT
107.SS Backend options
108.sp
109The following options are from the \fB[anastasis\-merchant\-backend]\fP section and used by
110the \fBanastasis\-httpd\fP service.
111.INDENT 0.0
112.TP
113.B PAYMENT_BACKEND_URL
114Base\-URL of the Taler merchant backend instance to use for payments.
115.TP
116.B API_KEY
117API key to transmit to the merchant backend for authentication.
118.UNINDENT
111.SS Authorization options 119.SS Authorization options
112.sp 120.sp
113For each active authorization plugin, options must be configured in 121For each active authorization plugin, options must be configured in a
114a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is 122section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is the
115the name of the authorization plugin. 123name of the authorization plugin. Specific plugins may require
124additional options, which are described in the respective sections
125below.
116.INDENT 0.0 126.INDENT 0.0
117.TP 127.TP
118.B COST 128.B COST
@@ -121,14 +131,39 @@ authorization plugin during recovery.
121.TP 131.TP
122.B ENABLED 132.B ENABLED
123\fByes\fP to enable this plugin, \fBno\fP to disable. 133\fByes\fP to enable this plugin, \fBno\fP to disable.
134.UNINDENT
135.SS SMS Authorization options
136.INDENT 0.0
124.TP 137.TP
125.B COMMAND 138.B COMMAND
126Helper command to run (only relevant for some plugins). 139Helper command to run to send SMS.
140.UNINDENT
141.SS Email Authorization options
142.INDENT 0.0
143.TP
144.B COMMAND
145Helper command to run to send E\-mail.
146.UNINDENT
147.SS Post Authorization options
148.INDENT 0.0
149.TP
150.B COMMAND
151Helper command to run to send physical mail.
152.UNINDENT
153.SS IBAN Authorization options
154.INDENT 0.0
155.TP
156.B CREDIT_IBAN
157IBAN number where the consumers must
158wire the money to for authentication.
159.TP
160.B BUSINESS_NAME
161Name of the account holder.
127.UNINDENT 162.UNINDENT
128.SS Postgres database configuration 163.SS Postgres database configuration
129.sp 164.sp
130The following options must be in the section \fB[statis\-postgres]\fP if 165The following options must be in the section \fB[statis\-postgres]\fP if
131\fBpostgress\fP was used for the database under \fBDB\fP in the 166\fBpostgres\fP was used for the database under \fBDB\fP in the
132\fB[anastasis]\fP section. 167\fB[anastasis]\fP section.
133.INDENT 0.0 168.INDENT 0.0
134.TP 169.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 = [
269 ("manpages/anastasis-reducer.1", "anastasis-reducer", 269 ("manpages/anastasis-reducer.1", "anastasis-reducer",
270 "anastasis CLI frontend", "Anastasis SARL", 270 "anastasis CLI frontend", "Anastasis SARL",
271 1), 271 1),
272 ("manpages/anastasis-helper-authorization-iban.1", "anastasis-helper-authorization-iban",
273 "anastasis IBAN authorization helper", "Anastasis SARL",
274 1),
272 ("manpages/anastasis-config.1", "anastasis-config", 275 ("manpages/anastasis-config.1", "anastasis-config",
273 "anastasis configuration file manipulation", "Anastasis SARL", 276 "anastasis configuration file manipulation", "Anastasis SARL",
274 1), 277 1),