folding history in preparation of GNU Anastasis v0.0.0 release

5 files changed, 417 insertions, 0 deletions

diff --git a/doc/sphinx/manpages/anastasis-config.1.rst b/doc/sphinx/manpages/anastasis-config.1.rst
new file mode 100644
index 0000000..043a22e
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-config.1.rst
@@ -0,0 +1,101 @@
+anastasis-config(1)
+###################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis-config** - manipulate Anastasis configuration files
+
+Synopsis
+========
+
+**anastasis-config**
+[**-b** *backend* | **––supported-backend=**\ \ *backend*]
+[**-c** *filename* | **––config=**\ \ *filename*]
+[**-f** | **––filename**]
+[**-F** | **––full**]
+[**-h** | **––help**]
+[**-L** *loglevel* | **––loglevel=**\ \ *loglevel*]
+[**-l** *filename* | **––logfile=**\ ‌\ *filename*]
+[**-o** *option* | **––option=**\ \ *option*]
+[**-r** | **––rewrite**]
+[**-S** | **––list-sections**]
+[**-s** *section* | **––section=**\ \ *section*]
+[**-V** *value* | **––value=**\ \ *value*]
+[**-v** | **––version**]
+
+
+Description
+===========
+
+**anastasis-config** can be used to read or modify Anastasis configuration files.
+
+**-b** *BACKEND* \| **––supported-backend=**\ \ *BACKEND*
+    Tests whether the specified *BACKEND* 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 *BACKEND* 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
+    anastasis-config to return a status code of 1 (error).
+
+**-c** *FILENAME* \| **––config=**\ \ *FILENAME*
+    Use the configuration file *FILENAME*.
+
+**-f** \| **––filename**
+    Try to perform expansions as if the option values represent filenames (will
+    also be applied even if the option is not really a filename).
+
+**-F** \| **––full**
+    Write the full configuration file, not just the differences to the defaults.
+
+**-h** \| **––help**
+    Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL*
+    Use *LOGLEVEL* for logging.
+    Valid values are ``DEBUG``, ``INFO``, ``WARNING``, and ``ERROR``.
+
+**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
+    Send logging output to *FILENAME*.
+
+**-o** *OPTION* \| **––option=**\ \ *OPTION*
+    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".
+
+**-r** \| **––rewrite**
+    Write the configuration file even if nothing changed. Will remove all comments!
+
+**-S** \| **––list-sections**
+    List available configuration sections for use with ``--section``.
+
+**-s** *SECTION* \| **––section=**\ \ *SECTION*
+    Which configuration section should be accessed or edited.
+    Required option.
+
+**-V** *VALUE* \| **––value=**\ \ *VALUE*
+    Configuration value to store in the given section under the given option.
+    Must only be given together with ``-s`` and ``-o`` options.
+
+    Note:
+       Changing the configuration file with ``-V`` will remove comments
+       and may reorder sections and remove ``@INLINE@`` directives.
+
+**-v** \| **––version**
+    Print Anastasis version number.
+
+
+
+See Also
+========
+
+anastasis.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.anastasis.lu or by sending electronic
+mail to <contact@anastasis.lu>.
diff --git a/doc/sphinx/manpages/anastasis-gtk.1.rst b/doc/sphinx/manpages/anastasis-gtk.1.rst
new file mode 100644
index 0000000..697f820
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-gtk.1.rst
@@ -0,0 +1,54 @@
+anastasis-gtk(1)
+################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis-gtk** - Gtk+ GUI for Anastasis
+
+Synopsis
+========
+
+**anastasis-gtk**
+[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
+[**-h** | **––help**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
+[**-v** | **––version**]
+
+
+Description
+===========
+
+**anastasis-gtk** is a graphical tool to run Anastasis
+key recover and backup operations.
+
+
+**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
+   Use the configuration from *FILENAME*.
+
+**-h** \| **––help**
+   Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
+   Send logging output to *FILENAME*.
+
+**-v** \| **––version**
+   Print version information.
+
+See Also
+========
+
+anastasis-reducer(1), anastasis-httpd(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
+mail to <contact@anastasis.lu>.
diff --git a/doc/sphinx/manpages/anastasis-httpd.1.rst b/doc/sphinx/manpages/anastasis-httpd.1.rst
new file mode 100644
index 0000000..599ede0
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-httpd.1.rst
@@ -0,0 +1,58 @@
+anastasis-httpd(1)
+##################
+
+.. only:: html
+
+  Name
+  ====
+
+  **anastasis-httpd** - run Anastasis backend (with RESTful API)
+
+
+Synopsis
+========
+
+**anastasis-httpd**
+
+Description
+===========
+
+Banastasis-httpd is a command line tool to run the Anastasis (HTTP
+backend).  The required configuration and database must exist before
+running this command.
+
+Its options are as follows:
+
+**-C** \| **--connection-close**
+   Force each HTTP connection to be closed after each request.
+
+**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the merchant to operate
+   from FILENAME.
+
+**-h** \| **––help**
+   Print short help on options.
+
+**-v** \| **––version**
+   Print version information.
+
+
+Signals
+=======
+
+**anastasis-httpd** responds to the following signals:
+
+``SIGTERM``
+    Sending a SIGTERM to the process will cause it to shutdown cleanly.
+
+See also
+========
+
+anastasis-dbinit(1), anastasis-config(1), anastasis-gtk(1), anastasis-reducer(1)
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.anastasis.lu or by sending
+electronic mail to <contact@anastasis.lu>.
diff --git a/doc/sphinx/manpages/anastasis-reducer.1.rst b/doc/sphinx/manpages/anastasis-reducer.1.rst
new file mode 100644
index 0000000..859dc49
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-reducer.1.rst
@@ -0,0 +1,71 @@
+anastasis-reducer(1)
+####################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis-reducer** - CLI for Anastasis
+
+Synopsis
+========
+
+**anastasis-reducer**
+[**-a**_*JSON*_|_**--arguments=\ \ *JSON*]
+[**-b**_|_**--backup]
+[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
+[**-h** | **––help**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
+[**-r**_|_**--restore]
+[**-v** | **––version**] COMMAND
+
+
+Description
+===========
+
+**anastasis-reducer** is a command-line tool to run Anastasis
+key recover and backup operations using a reducer-style interface.
+The reducer will read the current state from standard input and
+write the resulting state to standard output.  A COMMAND must
+be given on the command line.  The arguments (if any) are to
+be given in JSON format to the **-a** option.  A list of
+commands can be found in the :doc:`../reducer`
+chapter.
+
+**-a** *JSON* \| **––arguments=**\ \ *JSON*
+   Provide JSON inputs for the given command.
+
+**-b** \| **--backup**
+   Begin fresh reducer operation for a back up operation.
+
+**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
+   Use the configuration from *FILENAME*.
+
+**-h** \| **––help**
+   Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
+   Send logging output to *FILENAME*.
+
+**-r** \| **--restore**
+   Begin fresh reducer operation for a restore operation.
+
+**-v** \| **––version**
+   Print version information.
+
+See Also
+========
+
+anastasis-gtk(1), anastasis-httpd(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
+mail to <contact@anastasis.lu>.
diff --git a/doc/sphinx/manpages/anastasis.conf.5.rst b/doc/sphinx/manpages/anastasis.conf.5.rst
new file mode 100644
index 0000000..4857803
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis.conf.5.rst
@@ -0,0 +1,133 @@
+anastasis.conf(5)
+#################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis.conf** - Anastasis configuration file
+
+
+Description
+===========
+
+The configuration file is line-oriented.
+Blank lines and whitespace at the beginning and end of a line are ignored.
+Comments start with ``#`` or ``%`` in the first column
+(after any beginning-of-line whitespace) and go to the end of the line.
+
+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 ``=`` (equal sign).
+Section names and options are *case-insensitive*.
+
+The values, however, are *case-sensitive*.
+In particular, boolean values are one of ``YES`` or ``NO``.
+Values can include whitespace by surrounding
+the entire value with ``"`` (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.
+
+Values that represent filenames can begin with a ``/bin/sh``-like
+variable reference.
+This can be simple, such as ``$TMPDIR/foo``, or complex,
+such as ``${TMPDIR:-${TMP:-/tmp}}/foo``.
+See ``[PATHS]`` (below).
+
+Values that represent a time duration are represented as a series of one or
+more ``NUMBER UNIT`` pairs, e.g. ``60 s``, ``4 weeks 1 day``, ``5 years 2 minutes``.
+
+Values that represent an amount are in the usual amount syntax:
+``CURRENCY:VALUE.FRACTION``, e.g. ``EUR:1.50``.
+The ``FRACTION`` portion may extend up to 8 places.
+
+Files containing default values for many of the options described below
+are installed under ``$ANASTASIS_PREFIX/share/taler/config.d/``.
+The configuration file given with **-c** to Anastasis binaries
+overrides these defaults.
+
+A configuration file may include another, by using the ``@INLINE@`` directive,
+for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
+include the entirety of ``sub.conf`` at that point in ``main.conf``.
+.. TODO: Document ‘anastasis-config -V’ in light of ‘@INLINE@’ in taler-config(1).
+
+
+GLOBAL OPTIONS
+--------------
+
+The following options are from the ``[anastasis]`` section and used by
+the **anastasis-httpd** service.
+
+PAYMENT_BACKEND_URL
+  Base-URL of the Taler merchant backend instance to use for payments.
+  FIXME: How do we pass the access token?
+
+ANNUAL_FEE
+  Annual fee to be paid for policy uploads, i.e. "EUR:1.5".
+
+TRUTH_UPLOAD_FEE
+  Annual fee to be paid for truth uploads, i.e. "EUR:1.5".
+
+DB
+  Database backend to use, only ``postgres`` is supported right now.
+
+UPLOAD_LIMIT_MB
+  Maximum upload size for policy uploads in megabytes. Default is 1.
+
+ANNUAL_POLICY_UPLOAD_LIMIT
+  Maximum number of policies uploaded per year of service. Default is 42.
+
+BUSINESS_NAME
+  Name of the business.
+
+SERVER_SALT
+  Must be set to a high-entropy random server salt that the provider must never
+  change after the initial configuration.
+
+PORT
+  TCP port on which the HTTP service should listen on.
+
+
+Authorization options
+---------------------
+
+For each active authorization plugin, options must be configured in
+a section called ``[authorization-$PLUGIN]`` where ``$PLUGIN`` is
+the name of the authorization plugin.
+
+COST
+  Fee the user has to pay to obtain a challenge from this
+  authorization plugin during recovery.
+
+ENABLED
+  ``yes`` to enable this plugin, ``no`` to disable.
+
+COMMAND
+  Helper command to run (only relevant for some plugins).
+
+
+Postgres database configuration
+-------------------------------
+
+The following options must be in the section ``[statis-postgres]`` if
+``postgres`` was used for the database under ``DB`` in the
+``[anastasis]`` section.
+
+CONFIG
+  Path under which the Postgres database is that the service
+  should use, i.e. ``postgres://anastasis``.
+
+
+SEE ALSO
+========
+
+anastasis-httpd(1), anastasis-config(1)
+
+BUGS
+====
+
+Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
+mail to <contact@anastasis.lu>.