summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2017-03-20 04:37:44 +0100
committerChristian Grothoff <christian@grothoff.org>2017-03-20 04:38:08 +0100
commitab0286f5831b7d2c74b990a5f66e05c89424e9ff (patch)
treebbb50f92953d1900dc654a1e42140e8bb6a891d2 /doc
parent3186dbf58a1ee01e2fab22b4a7f0b2d0deccd71a (diff)
downloadexchange-ab0286f5831b7d2c74b990a5f66e05c89424e9ff.tar.gz
exchange-ab0286f5831b7d2c74b990a5f66e05c89424e9ff.tar.bz2
exchange-ab0286f5831b7d2c74b990a5f66e05c89424e9ff.zip
finish #3775, including addition of man page
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/taler-auditor.129
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a857db572..f55160993 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -3,6 +3,7 @@
SUBDIRS = . doxygen
man_MANS = \
+ taler-auditor.1 \
taler-auditor-sign.1 \
taler-config-generate.1 \
taler-exchange-aggregator.1 \
diff --git a/doc/taler-auditor.1 b/doc/taler-auditor.1
new file mode 100644
index 000000000..7682bf95f
--- /dev/null
+++ b/doc/taler-auditor.1
@@ -0,0 +1,29 @@
+.TH TALER\-AUDITOR 1 "Mar 20, 2017" "GNU Taler"
+
+.SH NAME
+taler\-auditor \- Audit exchange.
+
+.SH SYNOPSIS
+.B taler\-auditor -m MASTER_KEY
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-auditor\fP 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.
+
+.SH OPTIONS
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-m KEY, \-\-exchange-key=KEY"
+Public master key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
+.B
+.IP "\-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.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
+
+.SH "SEE ALSO"
+\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)