[GNUnet-SVN] [taler-exchange] branch master updated: finish #3775, including addition of man page

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository exchange.

The following commit(s) were added to refs/heads/master by this push:
     new ab0286f  finish #3775, including addition of man page
ab0286f is described below

commit ab0286f5831b7d2c74b990a5f66e05c89424e9ff
Author: Christian Grothoff <address@hidden>
AuthorDate: Mon Mar 20 04:37:44 2017 +0100

    finish #3775, including addition of man page
---
 ChangeLog                   |  3 +++
 doc/Makefile.am             |  1 +
 doc/taler-auditor.1         | 29 +++++++++++++++++++++++++++++
 src/auditor/taler-auditor.c |  2 +-
 4 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/ChangeLog b/ChangeLog
index 40743eb..93d03f4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,6 @@
+Mon Mar 20 04:37:46 CET 2017
+       Implemented first working version of taler-auditor. -CG
+
 Sat Mar 18 03:44:38 CET 2017
        Add 'wire_out' table to exchange DB to track outgoing
        wire transfers. -CG
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a857db5..f551609 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 0000000..7682bf9
--- /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  [...]
+
+.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 <address@hidden>
+
+.SH "SEE ALSO"
+\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
diff --git a/src/auditor/taler-auditor.c b/src/auditor/taler-auditor.c
index c03af0e..3b6f3c4 100644
--- a/src/auditor/taler-auditor.c
+++ b/src/auditor/taler-auditor.c
@@ -3360,7 +3360,7 @@ main (int argc,
                                            &master_pub)),
     GNUNET_GETOPT_OPTION_SET_ONE ('r',
                                   "restart",
-                                  "restart audit from the beginning",
+                                  "restart audit from the beginning (required 
on first run)",
                                   &restart),
     GNUNET_GETOPT_OPTION_END
   };

-- 
To stop receiving notification emails like this one, please contact
address@hidden