summaryrefslogtreecommitdiff
path: root/man/taler-auditor.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/taler-auditor.1')
-rw-r--r--man/taler-auditor.180
1 files changed, 80 insertions, 0 deletions
diff --git a/man/taler-auditor.1 b/man/taler-auditor.1
new file mode 100644
index 00000000..7a1c9654
--- /dev/null
+++ b/man/taler-auditor.1
@@ -0,0 +1,80 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "TALER-AUDITOR" "1" "Sep 18, 2019" "0.6pre1" "GNU Taler"
+.SH NAME
+taler-auditor \- audit exchange
+.
+.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
+..
+.sp
+\fBtaler\-auditor\fP \- audit exchange
+.SH SYNOPSIS
+.sp
+\fBtaler\-auditor\fP [\fB\-h\fP\ |\ \fB–help\fP]
+[\fB\-m\fP\ \fIMASTER_KEY\fP\ |\ \fB–exchange\-key=\fP‌\fIMASTER_KEY\fP]
+[\fB\-r\fP\ |\ \fB–reset\fP]
+.SH DESCRIPTION
+.sp
+\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 \fB\-r\fP 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.
+.INDENT 0.0
+.TP
+\fB\-h\fP | \fB–help\fP
+Print short help on options.
+.TP
+\fB\-m\fP \fIKEY\fP | \fB–exchange\-key=\fP‌\fIKEY\fP
+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.
+.TP
+\fB\-r\fP | \fB–reset\fP
+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 \fB\-r\fP option
+should not be used again.
+.UNINDENT
+.SH SEE ALSO
+.sp
+gnunet\-ecc(1), taler\-auditor\-sign(1), taler.conf(5)
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.gnunet.org\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014, 2015, 2016 Florian Dold, Benedikt Muller, Sree Harsha Totakura, Christian Grothoff, Marcello Stanisci (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.