aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/manpages')
-rw-r--r--doc/sphinx/manpages/anastasis-dbconfig.1.rst61
-rw-r--r--doc/sphinx/manpages/anastasis-dbinit.1.rst67
-rw-r--r--doc/sphinx/manpages/anastasis-gtk.1.rst15
-rw-r--r--doc/sphinx/manpages/anastasis-reducer.1.rst14
-rw-r--r--doc/sphinx/manpages/anastasis.conf.5.rst6
5 files changed, 160 insertions, 3 deletions
diff --git a/doc/sphinx/manpages/anastasis-dbconfig.1.rst b/doc/sphinx/manpages/anastasis-dbconfig.1.rst
new file mode 100644
index 0000000..3483c36
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-dbconfig.1.rst
@@ -0,0 +1,61 @@
+anastasis-dbconfig(1)
+#####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **anastasis-dbconfig** - configure Anastasis database
+
+
+Synopsis
+========
+
+**anastasis-dbconfig**
+[**-c** *FILENAME* *]
+[**-h**]
+[**-n** *NAME* *]
+[**-r**]
+[**-s**]
+[**-u** *USER* *]
+
+Description
+===========
+
+**anastasis-dbconfig** is a simple shell script that configures
+a Postgresql database for use by the GNU Anastasis servers.
+
+Its options are as follows:
+
+**-c** *FILENAME*
+ Write the database configuration to FILENAME. The tool
+ will append the required ``CONFIG`` option for the
+ Postgresql access to the respective file.
+
+**-h**
+ Print short help on options.
+
+**-n** *DBNAME*
+ Use DBNAME for the name of the created database.
+
+**-r**
+ Reset any existing database. Looses all existing data. DANGEROUS.
+
+**-s**
+ Skip database initialization. Useful if you want to run
+ ``anastasis-dbinit`` manually.
+
+**-u** *USER*
+ Specifies the (main) Anastasis user that will access the database.
+
+See Also
+========
+
+anastassis-dbinit(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/doc/sphinx/manpages/anastasis-dbinit.1.rst b/doc/sphinx/manpages/anastasis-dbinit.1.rst
new file mode 100644
index 0000000..1b0d5fa
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-dbinit.1.rst
@@ -0,0 +1,67 @@
+anastasis-dbinit(1)
+###################
+
+.. only:: html
+
+ Name
+ ====
+
+ **anastasis-dbinit** - initialize Anastasis database
+
+
+Synopsis
+========
+
+**anastasis-dbinit**
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-g** | **--gc**]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
+[**-r** | **--reset**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**anastasis-dbinit** is a command-line tool to initialize the GNU
+Anastasis database. It creates the necessary tables and indices for
+an Anastasis server to operate.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+ Use the configuration and other resources for the exchange to operate
+ from *FILENAME*.
+
+**-g** \| **--gc**
+ Garbage collect database. Deletes all unnecessary data in the
+ database.
+
+**-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** \| **--reset**
+ Drop tables. Dangerous, will delete all existing data in the database
+ before creating the tables.
+
+**-v** \| **–version**
+ Print version information.
+
+See Also
+========
+
+anastasis-httpd(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/doc/sphinx/manpages/anastasis-gtk.1.rst b/doc/sphinx/manpages/anastasis-gtk.1.rst
index 697f820..b039fbf 100644
--- a/doc/sphinx/manpages/anastasis-gtk.1.rst
+++ b/doc/sphinx/manpages/anastasis-gtk.1.rst
@@ -12,6 +12,7 @@ Synopsis
========
**anastasis-gtk**
+[**-A**_*ID*_|_**--application=**\ \ *ID*]
[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
[**-h** | **––help**]
[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
@@ -26,6 +27,20 @@ Description
key recover and backup operations.
+**-A** *ID* \| **--application=**\ \ *ID*
+ Set the application ID to *ID*. Default is ``anastasis-gtk``. Used
+ to store different types of secrets from different applications
+ while using the same user attributes. Basically the application ID
+ is included in the user attributes. Not changable by the GUI as
+ only advanced users should even known about this. Applications that
+ tightly integrate Anastasis should set the application ID to their
+ respective unique name, for example the GNU Taler wallet may use
+ ``gnu-taler-wallet`` for the application ID. If anastasis-gtk is
+ to be used to recover such a secret, the respective application ID
+ must be provided on the command-line. Users that only use
+ anastasis-gtk to backup and restore secrets should not set the
+ application ID, as forgetting the ID makes the secrets irrecoverable.
+
**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
Use the configuration from *FILENAME*.
diff --git a/doc/sphinx/manpages/anastasis-reducer.1.rst b/doc/sphinx/manpages/anastasis-reducer.1.rst
index 859dc49..9884b18 100644
--- a/doc/sphinx/manpages/anastasis-reducer.1.rst
+++ b/doc/sphinx/manpages/anastasis-reducer.1.rst
@@ -12,6 +12,7 @@ Synopsis
========
**anastasis-reducer**
+[**-A**_*ID*_|_**--application=**\ \ *ID*]
[**-a**_*JSON*_|_**--arguments=\ \ *JSON*]
[**-b**_|_**--backup]
[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
@@ -37,6 +38,19 @@ chapter.
**-a** *JSON* \| **––arguments=**\ \ *JSON*
Provide JSON inputs for the given command.
+**-A** *ID* \| **--application=**\ \ *ID*
+ Set the application ID to *ID*. Default is empty, which means the application-id must be explicitly provided
+ as part of the JSON inputs or it will be omitted.
+ The **-A** option overrides any application ID that
+ may be given in the **-a** arguments. Application IDs
+ are used to store different types of secrets from different applications
+ while using the same user attributes. Basically the application ID
+ is included in the user attributes. Applications that
+ tightly integrate Anastasis should set the application ID to their
+ respective unique name, for example the GNU Taler wallet may use
+ ``gnu-taler-wallet`` for the application ID.
+ Forgetting the application ID makes the secrets irrecoverable.
+
**-b** \| **--backup**
Begin fresh reducer operation for a back up operation.
diff --git a/doc/sphinx/manpages/anastasis.conf.5.rst b/doc/sphinx/manpages/anastasis.conf.5.rst
index 000d8f0..a32cd4c 100644
--- a/doc/sphinx/manpages/anastasis.conf.5.rst
+++ b/doc/sphinx/manpages/anastasis.conf.5.rst
@@ -125,20 +125,20 @@ SMS Authorization options
^^^^^^^^^^^^^^^^^^^^^^^^^
COMMAND
- Helper command to run to send SMS.
+ Helper command to run to send SMS. The command will be given the phone number as its first argument. The message to be transmitted will be passed via STDIN.
Email Authorization options
^^^^^^^^^^^^^^^^^^^^^^^^^^^
COMMAND
- Helper command to run to send E-mail.
+ Helper command to run to send E-mail. The command will be given the e-mail address as its first argument. The message to be transmitted will be passed via STDIN.
Post Authorization options
^^^^^^^^^^^^^^^^^^^^^^^^^^
COMMAND
- Helper command to run to send physical mail.
+ Helper command to run to send physical mail. The command will be given the mailing address address as its first argument in JSON object fields 'full_name', 'street', 'city', 'postcode' and 'country'. The message to be transmitted will be passed via STDIN.
IBAN Authorization options