From 0d8f5035437d5a0daff3505978bc60dad50f55f2 Mon Sep 17 00:00:00 2001 From: ng0 Date: Tue, 7 May 2019 14:34:49 +0000 Subject: doc: rewrite. --- doc/taler-auditor.1 | 70 ++++++++++++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 28 deletions(-) (limited to 'doc/taler-auditor.1') diff --git a/doc/taler-auditor.1 b/doc/taler-auditor.1 index dc4da2381..c0b82d64d 100644 --- a/doc/taler-auditor.1 +++ b/doc/taler-auditor.1 @@ -1,29 +1,43 @@ -.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" +.Dd March 20, 2017 +.Dt TALER-AUDITOR 1 +.Os +.Sh NAME +.Nm taler-auditor +.Nd +Audit exchange +.Sh SYNOPSIS +.Nm +.Op Fl h | \-help +.Op Fl m Ar MASTER_KEY | Fl \-exchange-key= Ns Ar MASTER_KEY +.Op Fl r | \-reset +.Sh DESCRIPTION +.Nm +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 +.Fl 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. +.Bl -tag -wdith Ds +.It Fl 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. If this option is missing, taler\-auditor will use the MASTER_PUBLIC_KEY value from the "exchange" section of the configuration. -.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 or by sending electronic mail to - -.SH "SEE ALSO" -\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5) +.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar 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. +.It Fl 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 +.Fl r +option should not be used again. +.Sh SEE ALSO +.Xr gnunet-ecc 1 , +.Xr taler-auditor-sign 1 , +.Xr taler.conf 5 +.Sh BUGS +Report bugs by using +.Lk https://bugs.gnunet.org +or by sending electronic mail to +.Aq Mt taler@gnu.org . -- cgit v1.2.3