diff options
author | ng0 <ng0@n0.is> | 2019-05-07 14:34:49 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-05-07 14:34:49 +0000 |
commit | 0d8f5035437d5a0daff3505978bc60dad50f55f2 (patch) | |
tree | 4975cdeabae82707035c03821199d3c97483ea9f /doc/taler-auditor-sign.1 | |
parent | 6e33de941e9a8fd63049337293be212f97555f1a (diff) | |
download | exchange-0d8f5035437d5a0daff3505978bc60dad50f55f2.tar.xz |
doc: rewrite.
Diffstat (limited to 'doc/taler-auditor-sign.1')
-rw-r--r-- | doc/taler-auditor-sign.1 | 80 |
1 files changed, 43 insertions, 37 deletions
diff --git a/doc/taler-auditor-sign.1 b/doc/taler-auditor-sign.1 index e5883dbc6..659dabca9 100644 --- a/doc/taler-auditor-sign.1 +++ b/doc/taler-auditor-sign.1 @@ -1,40 +1,46 @@ -.TH TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler" - -.SH NAME -taler\-auditor\-sign \- Sign exchange 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 exchange. Using this signature, the auditor affirms that he will verify that the exchange is properly accounting for those coins. - +.Dd +.Dt TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler" +.Os +.Sh NAME +.Nm taler\-auditor\-sign +.Nd +Sign exchange denomination as auditor. +.Sh SYNOPSIS +.Nm +.Op Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE +.Op Fl h | \-help +.Op Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY +.Op Fl u Ar URL | Fl \-auditor-url= Ns Ar URL +.Op Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE +.Op Fl o Ar FILE | Fl \-output= Ns Ar FILE +.Sh DESCRIPTION +.Nm +is a command line tool to be used by an auditor to sign that he is aware of certain keys being used by a exchange. +Using this signature, the auditor affirms that he will verify that the exchange is properly accounting for those coins. +.Pp The exchange for which keys were signed must have been added to the auditor using taler\-auditor\-exchange first! - -.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" +.Bl -tag -width Ds +.It Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE +Location of the private EdDSA auditor key. +If it does not exist, it will be created. +.It Fl h | \-help Print short help on options. -.B -.IP "\-m KEY, \-\-exchange-key=KEY" -Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p. -.B -.IP "\-u URL, \-\-auditor-url=URL" -URL of the auditor. Provides informative link for the user to learn more about the auditor. -.B -.IP "\-r FILE, \-\-exchange-request=FILE" -File with the exchange's denomination key signing request as generated by taler\-exchange\-keyup \-o. -.B -.IP "\-o FILE, \-\-output=FILE" +.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY +Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p. +.It Fl u Ar URL | Fl \-auditor-url= Ns Ar URL +URL of the auditor. +Provides informative link for the user to learn more about the auditor. +.It Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE +File with the exchange's denomination key signing request as generated by taler-exchange-keyup -o. +.It Fl o Ar FILE | Fl \-output= Ns Ar 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\-auditor\-exchange\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5) +.Sh SEE ALSO +.Xr gnunet-ecc 1 , +.Xr taler-auditor-exchange 1 , +.Xr taler-exchange-keyup 1 , +.Xr taler.conf 5 +.Sh BUGS +Report bugs by using +.Lk https://gnunet.org/bugs/ +or by sending electronic mail to +.Aq Mt taler@gnu.org . |