Add Sync manpages

* man/sync-config.1: New.
* man/sync-dbinit.1: New.
* man/sync-httpd.1: New.
* man/sync.conf.5: New.

4 files changed, 446 insertions, 0 deletions

diff --git a/man/sync-config.1 b/man/sync-config.1
new file mode 100644
index 00000000..6d234ba7
--- /dev/null
+++ b/man/sync-config.1
@@ -0,0 +1,123 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "SYNC-CONFIG" "1" "Dec 23, 2021" "0.8" "GNU Taler"
+.SH NAME
+sync-config \- manipulate Sync configuration files
+.
+.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
+\fBsync\-config\fP
+[\fB\-b\fP\ \fIbackend\fP\ |\ \fB\-\-supported\-backend=\fP\fIbackend\fP]
+[\fB\-c\fP\ \fIfilename\fP\ |\ \fB\-\-config=\fP\fIfilename\fP]
+[\fB\-f\fP\ |\ \fB\-\-filename\fP]
+[\fB\-F\fP\ |\ \fB\-\-full\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\-o\fP\ \fIoption\fP\ |\ \fB\-\-option=\fP\fIoption\fP]
+[\fB\-r\fP\ |\ \fB\-\-rewrite\fP]
+[\fB\-S\fP\ |\ \fB\-\-list\-sections\fP]
+[\fB\-s\fP\ \fIsection\fP\ |\ \fB\-\-section=\fP\fIsection\fP]
+[\fB\-V\fP\ \fIvalue\fP\ |\ \fB\-\-value=\fP\fIvalue\fP]
+[\fB\-v\fP\ |\ \fB\-\-version\fP]
+.SH DESCRIPTION
+.sp
+\fBsync\-config\fP can be used to read or modify Sync configuration files.
+.INDENT 0.0
+.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
+supported, sync\-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
+sync\-config to return a status code of 1 (error).
+.TP
+\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP
+Use the configuration file \fIFILENAME\fP\&.
+.TP
+\fB\-f\fP | \fB\-\-filename\fP
+Try to perform expansions as if the option values represent filenames (will
+also be applied even if the option is not really a filename).
+.TP
+\fB\-F\fP | \fB\-\-full\fP
+Write the full configuration file, not just the differences to the defaults.
+.TP
+\fB\-h\fP | \fB\-\-help\fP
+Print short help on options.
+.TP
+\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP
+Use \fILOGLEVEL\fP for logging.
+Valid values are \fBDEBUG\fP, \fBINFO\fP, \fBWARNING\fP, and \fBERROR\fP\&.
+.TP
+\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP‌\fIFILENAME\fP
+Send logging output to \fIFILENAME\fP\&.
+.TP
+\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".
+.TP
+\fB\-r\fP | \fB\-\-rewrite\fP
+Write the configuration file even if nothing changed. Will remove all comments!
+.TP
+\fB\-S\fP | \fB\-\-list\-sections\fP
+List available configuration sections for use with \fB\-\-section\fP\&.
+.TP
+\fB\-s\fP \fISECTION\fP | \fB\-\-section=\fP\fISECTION\fP
+Which configuration section should be accessed or edited.
+Required option.
+.TP
+\fB\-V\fP \fIVALUE\fP | \fB\-\-value=\fP\fIVALUE\fP
+Configuration value to store in the given section under the given option.
+Must only be given together with \fB\-s\fP and \fB\-o\fP options.
+.INDENT 7.0
+.TP
+.B Note:
+Changing the configuration file with \fB\-V\fP will remove comments
+and may reorder sections and remove \fB@INLINE@\fP directives.
+.UNINDENT
+.TP
+\fB\-v\fP | \fB\-\-version\fP
+Print GNU Taler version number.
+.UNINDENT
+.SH SEE ALSO
+.sp
+sync\-dbinit(1), sync\-httpd(1), sync.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.
diff --git a/man/sync-dbinit.1 b/man/sync-dbinit.1
new file mode 100644
index 00000000..85dc55e6
--- /dev/null
+++ b/man/sync-dbinit.1
@@ -0,0 +1,84 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "SYNC-DBINIT" "1" "Dec 23, 2021" "0.8" "GNU Taler"
+.SH NAME
+sync-dbinit \- initialize the Sync database
+.
+.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
+\fBsync\-dbinit\fP
+[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP‌\fIFILENAME\fP]
+[\fB\-g\fP\ |\ \fB\-\-garbagecollect\fP]
+[\fB\-h\fP\ |\ \fB\-\-help\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP]
+[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP]
+[\fB\-r\fP\ |\ \fB\-\-reset\fP]
+[\fB\-v\fP\ |\ \fB\-\-version\fP]
+.SH DESCRIPTION
+.sp
+\fBsync\-dbinit\fP is a command\-line tool to initialize the Sync database.
+.sp
+Its options are as follows:
+.INDENT 0.0
+.TP
+\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP‌\fIFILENAME\fP
+Use the configuration and other resources for the Sync commands
+to operate from \fIFILENAME\fP\&.
+.TP
+\fB\-g\fP | \fB\-\-garbagecollect\fP
+Remove state data from database.
+.TP
+\fB\-h\fP | \fB\-\-help\fP
+Print short help on options.
+.TP
+\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP
+Configure logging to use \fILOGLEVEL\fP\&.
+.TP
+\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP
+Configure logging to write logs to \fIFILENAME\fP\&.
+.TP
+\fB\-r\fP | \fB\-\-reset\fP
+Reset database.  (\fBDANGEROUS\fP: All existing data is lost!)
+.TP
+\fB\-v\fP | \fB–version\fP
+Print version information.
+.UNINDENT
+.SH SEE ALSO
+.sp
+sync\-config(1), sync\-httpd(1), sync.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.
diff --git a/man/sync-httpd.1 b/man/sync-httpd.1
new file mode 100644
index 00000000..cd73bc42
--- /dev/null
+++ b/man/sync-httpd.1
@@ -0,0 +1,97 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "SYNC-HTTPD" "1" "Dec 23, 2021" "0.8" "GNU Taler"
+.SH NAME
+sync-httpd \- provide the Sync HTTP interface
+.
+.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
+\fBsync\-httpd\fP
+[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP]
+[\fB\-C\fP\ |\ \fB\-\-connection\-close\fP]
+[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP‌\fIFILENAME\fP]
+[\fB\-h\fP\ |\ \fB\-\-help\fP]
+[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB\-\-key=\fP\fIKEYFILE\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP]
+[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP]
+[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP]
+[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB\-\-type=\fP\fICERTTYPE\fP]
+[\fB\-v\fP\ |\ \fB\-\-version\fP]
+.SH DESCRIPTION
+.sp
+\fBsync\-httpd\fP is a command\-line tool to provide the Sync HTTP interface.
+.sp
+Its options are as follows:
+.INDENT 0.0
+.TP
+\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP
+Use the given \fIUSERNAME\fP and \fIPASSWORD\fP for client authentication.
+.TP
+\fB\-C\fP | \fB\-\-connection\-close\fP
+Force HTTP connections to be closed after each request.
+.TP
+\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP‌\fIFILENAME\fP
+Use the configuration and other resources for the Sync commands
+to operate from \fIFILENAME\fP\&.
+.TP
+\fB\-h\fP | \fB\-\-help\fP
+Print short help on options.
+.TP
+\fB\-k\fP \fIKEYFILE\fP | \fB\-\-key=\fP\fIKEYFILE\fP
+Consult \fIKEYFILE\fP for the private TLS key for TLS client authentication.
+.TP
+\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP
+Configure logging to use \fILOGLEVEL\fP\&.
+.TP
+\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP
+Configure logging to write logs to \fIFILENAME\fP\&.
+.TP
+\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP
+Use \fIKEYFILEPASSPHRASE\fP to decrypt the TLS client private key file.
+.TP
+\fB\-t\fP \fICERTTYPE\fP | \fB\-\-type=\fP\fICERTTYPE\fP
+Use \fICERTTYPE\fP as the type of the TLS client certificate.
+If unspecified, defaults to PEM.
+.TP
+\fB\-v\fP | \fB–version\fP
+Print version information.
+.UNINDENT
+.SH SEE ALSO
+.sp
+sync\-config(1), sync\-dbinit(1), sync.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.
diff --git a/man/sync.conf.5 b/man/sync.conf.5
new file mode 100644
index 00000000..61d856a1
--- /dev/null
+++ b/man/sync.conf.5
@@ -0,0 +1,142 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "SYNC.CONF" "5" "Dec 23, 2021" "0.8" "GNU Taler"
+.SH NAME
+sync.conf \- Sync configuration file
+.
+.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 DESCRIPTION
+.sp
+The configuration file is line\-oriented.
+Blank lines and whitespace at the beginning and end of a line are ignored.
+Comments start with \fB#\fP or \fB%\fP in the first column
+(after any beginning\-of\-line whitespace) and go to the end of the line.
+.sp
+The file is split into sections.
+Every section begins with “[SECTIONNAME]” and
+contains a number of options of the form “OPTION=VALUE”.
+There may be whitespace around the \fB=\fP (equal sign).
+Section names and options are \fIcase\-insensitive\fP\&.
+.sp
+The values, however, are \fIcase\-sensitive\fP\&.
+In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&.
+Values can include whitespace by surrounding
+the entire value with \fB"\fP (double quote).
+Note, however, that there are no escape characters in such strings;
+all characters between the double quotes (including other double quotes)
+are taken verbatim.
+.sp
+Values that represent filenames can begin with a \fB/bin/sh\fP\-like
+variable reference.
+This can be simple, such as \fB$TMPDIR/foo\fP, or complex,
+such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&.
+See \fB[PATHS]\fP (below).
+.sp
+Values that represent a time duration are represented as a series
+of one or more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP,
+\fB5 years 2 minutes\fP\&.
+.sp
+Values that represent an amount are in the usual amount syntax:
+\fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&.
+The \fBFRACTION\fP portion may extend up to 8 places.
+.sp
+Files containing default values for many of the options described below
+are installed under \fB$PREFIX/share/sync/config.d/\fP\&.
+The configuration file given with \fB\-c\fP to Sync binaries
+overrides these defaults.
+.sp
+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\&.
+.sp
+Be extra careful when using \fBsync\-config \-V VALUE\fP to change configuration
+values: it will destroy all uses of \fB@INLINE@\fP and furthermore remove all
+comments from the configuration file!
+.SS GLOBAL OPTIONS
+.sp
+The following options are from the “[sync]” section.
+This is normally the only section in a sync.conf file.
+.INDENT 0.0
+.TP
+.B SERVE
+This can either be \fBtcp\fP or \fBunix\fP\&.
+.TP
+.B PORT
+Port on which the HTTP server listens, e.g.\ 9967.
+Only used if \fBSERVE\fP is \fBtcp\fP\&.
+.TP
+.B BIND_TO
+Which IP address should we bind to?  E.g. \fB127.0.0.1\fP or \fB::1\fP
+for loopback.  Can also be given as a hostname.  We will bind to
+the wildcard (dual\-stack) if left empty.
+Only used if \fBSERVE\fP is \fBtcp\fP\&.
+.TP
+.B UNIXPATH
+Which unix domain path should we bind to?
+Only used if \fBSERVE\fP is \fBunix\fP\&.
+.TP
+.B UNIXPATH_MODE = 660
+What should be the file access permissions for \fBUNIXPATH\fP?
+Only used if \fBSERVE\fP is \fBunix\fP\&.
+.TP
+.B DB
+Plugin to use for the database, e.g.\ “postgres”.
+.TP
+.B ANNUAL_FEE
+Annual fee for an account.
+This is in the usual amount syntax, e.g. \fBTESTKUDOS:0.1\fP\&.
+.TP
+.B INSURANCE
+Insurance provided against loss, e.g. \fBTESTKUDOS:0.0\fP\&.
+.TP
+.B UPLOAD_LIMIT_MB
+Upload limit per backup, in megabytes, e.g. \fB16\fP\&.
+.TP
+.B FULFILLMENT_URL
+Fulfillment URL of the SYNC service itself.
+.TP
+.B PAYMENT_BACKEND_URL
+Base URL of our payment backend.
+.TP
+.B API_KEY
+API key to pass when accessing the merchant backend.
+This is a secret value.
+.UNINDENT
+.SH SEE ALSO
+.sp
+sync\-dbinit(1), sync\-httpd(1), sync\-config(1).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.