summaryrefslogtreecommitdiff
path: root/manpages/taler-auditor.1.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
committerFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
commit5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10 (patch)
tree5f75fd693a1d062c7e5702f30c466c24a90e0fe2 /manpages/taler-auditor.1.rst
parentaf61db1b78f82241163861a5770d67e2442ef803 (diff)
downloaddocs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.gz
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.bz2
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.zip
manpages live here now
Diffstat (limited to 'manpages/taler-auditor.1.rst')
-rw-r--r--manpages/taler-auditor.1.rst55
1 files changed, 55 insertions, 0 deletions
diff --git a/manpages/taler-auditor.1.rst b/manpages/taler-auditor.1.rst
new file mode 100644
index 0000000..e3742d9
--- /dev/null
+++ b/manpages/taler-auditor.1.rst
@@ -0,0 +1,55 @@
+taler-auditor(1)
+################
+
+.. only:: html
+
+ Name
+ ====
+
+**taler-auditor** - audit exchange
+
+Synopsis
+========
+
+**taler-auditor** [**-h** | **--help**]
+[**-m** *MASTER_KEY* | **--exchange-key=**\ ‌\ *MASTER_KEY*]
+[**-r** | **--reset**]
+
+Description
+===========
+
+**taler-auditor** is a command line tool to be used by an auditor to
+audit an exchange’s database and calculate the current financial state
+of the exchange (including revenue, amount expected in escrow and risk
+exposure). The audit is incremental. The first audit must be performed
+with the **-r** option to initialize the tables. The tool reports
+inconsistencies in the balance or incorrect cryptographic signatures
+found in the database. It does NOT check with the bank to see that the
+incoming and outgoing wire transfers that the bank claims to have
+matches the exchange’s database. Its options are as follows.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-m** *KEY* \| **--exchange-key=**\ ‌\ *KEY*
+ Public master key of the exchange in Crockford base32 encoding, for
+ example as generated by gnunet-ecc -p. If this option is missing,
+ taler-auditor will use the MASTER_PUBLIC_KEY value from the
+ “exchange” section of the configuration.
+
+**-r** \| **--reset**
+ Reset the audit, starts everything from the beginning. Useful for
+ testing and required for the first audit to setup auditor’s tables.
+ Note that if (just) the exchange key changes, the **-r** option
+ should not be used again.
+
+See Also
+========
+
+gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.gnunet.org or by sending electronic
+mail to <taler@gnu.org>.