adding man page for taler-auditor-sign

This commit is contained in:
Christian Grothoff 2015-09-16 18:48:52 +02:00
parent cee6c54cdf
commit 2fa65141a6
3 changed files with 39 additions and 3 deletions

View File

@ -3,12 +3,13 @@
SUBDIRS = . doxygen SUBDIRS = . doxygen
man_MANS = \ man_MANS = \
taler-auditor-sign.1 \
taler-mint-dbinit.1 \ taler-mint-dbinit.1 \
taler-mint-httpd.1 \ taler-mint-httpd.1 \
taler-mint-keyup.1 \ taler-mint-keyup.1 \
taler-mint-keycheck.1 \ taler-mint-keycheck.1 \
taler-mint-reservemod.1 \ taler-mint-reservemod.1 \
taler.conf.5 taler.conf.5
EXTRA_DIST = \ EXTRA_DIST = \
coding-style.txt \ coding-style.txt \

35
doc/taler-auditor-sign.1 Normal file
View File

@ -0,0 +1,35 @@
.TH TALER\-AUDITOR\-SIGN 1 "Sep 15, 2015" "GNU Taler"
.SH NAME
taler\-auditor\-sign \- Sign mint denomination as auditor.
.SH SYNOPSIS
.B taler\-auditor\-sign
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-auditor\-sign\fP is a command line tool to be used by an auditor to sign that he is aware of certain keys being used by a mint. Using this signature, the auditor affirms that he will verify that the mint is properly accounting for those coins.
.SH OPTIONS
.B
.IP "\-a FILE, \-\-auditor-key=FILE"
Location of the private EdDSA auditor key. If it does not exist, it will be created.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-m KEY, \-\-mint-key=KEY"
Public key of the mint in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
.B
.IP "\-r FILE, \-\-mint-request=FILE"
File with the mint's denomination key signing request as generated by taler\-mint\-keyup \-o.
.B
.IP "\-o FILE, \-\-output=FILE"
File where the auditor should write the EdDSA signature.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-mint\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)

View File

@ -79,10 +79,10 @@ main (int argc,
"public key of the mint (Crockford base32 encoded)", 1, "public key of the mint (Crockford base32 encoded)", 1,
&GNUNET_GETOPT_set_filename, &mint_public_key}, &GNUNET_GETOPT_set_filename, &mint_public_key},
{'r', "mint-request", "FILE", {'r', "mint-request", "FILE",
"set of keys the mint requested the auditor to sign", 0, "set of keys the mint requested the auditor to sign", 1,
&GNUNET_GETOPT_set_string, &mint_request_file}, &GNUNET_GETOPT_set_string, &mint_request_file},
{'o', "output", "FILE", {'o', "output", "FILE",
"where to write our signature", 0, "where to write our signature", 1,
&GNUNET_GETOPT_set_string, &output_file}, &GNUNET_GETOPT_set_string, &output_file},
GNUNET_GETOPT_OPTION_VERSION (VERSION "-" VCS_VERSION), GNUNET_GETOPT_OPTION_VERSION (VERSION "-" VCS_VERSION),
GNUNET_GETOPT_OPTION_END GNUNET_GETOPT_OPTION_END