summaryrefslogtreecommitdiff
path: root/man/taler-auditor-offline.1
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2024-02-10 23:07:31 +0100
committerChristian Grothoff <christian@grothoff.org>2024-02-10 23:07:31 +0100
commitff81b14cfa6a753e6b9015a7057519c2b444c9bb (patch)
treec067b83c5aec951f7ca3985483109543b4811f7e /man/taler-auditor-offline.1
parent300a469342ba879b16ff93aaaf170fa1b88e75fb (diff)
downloaddocs-ff81b14cfa6a753e6b9015a7057519c2b444c9bb.tar.gz
docs-ff81b14cfa6a753e6b9015a7057519c2b444c9bb.tar.bz2
docs-ff81b14cfa6a753e6b9015a7057519c2b444c9bb.zip
regen
Diffstat (limited to 'man/taler-auditor-offline.1')
-rw-r--r--man/taler-auditor-offline.174
1 files changed, 43 insertions, 31 deletions
diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1
index 8181e1b4..00612940 100644
--- a/man/taler-auditor-offline.1
+++ b/man/taler-auditor-offline.1
@@ -33,12 +33,12 @@ taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange
.SH SYNOPSIS
.sp
\fBtaler\-auditor\-offline\fP
-[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP‌\fIFILENAME\fP]
-[\fB\-h\fP\ |\ \fB–help\fP]
-[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP‌\fILOGLEVEL\fP]
-[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP‌\fIFILENAME\fP]
-[\fB\-v\fP\ |\ \fB–version\fP]
-[subcommand …]
+[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP‌\fIFILENAME\fP]
+[\fB\-h\fP\ |\ \fB\-\-help\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP‌\fILOGLEVEL\fP]
+[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP‌\fIFILENAME\fP]
+[\fB\-v\fP\ |\ \fB\-\-version\fP]
+[subcommand ...]
.SH DESCRIPTION
.sp
\fBtaler\-auditor\-offline\fP is a command\-line tool to be used by an auditor to
@@ -47,7 +47,7 @@ signature, the auditor affirms that he will verify that the exchange is
properly accounting for coins of those denominations. The tool takes a list
of subcommands as arguments which are then processed sequentially.
.sp
-The tool includes two subcommands to interact \fIonline\fP with the exchange’s
+The tool includes two subcommands to interact \fIonline\fP with the exchange\(aqs
REST APIs. The \fBdownload\fP subcommand downloads current public keys from the
running exchange. Note that this only includes keys that the exchange
operator has previously validated using the \fBtaler\-exchange\-offline\fP tool.
@@ -55,10 +55,10 @@ The resulting data serves as input to the \fBsign\fP and \fBshow\fP subcommands.
.sp
The \fBupload\fP subcommand uploads the signatures created with the private key to
the exchange. It handles the output of all subcommands (except \fBdownload\fP).
-The \fBdownload\fP and \fBupload\fP subcommands must naturally be run “online” and do not
-require access to the auditor’s private key, which should be kept offline.
+The \fBdownload\fP and \fBupload\fP subcommands must naturally be run \(dqonline\(dq and do not
+require access to the auditor\(aqs private key, which should be kept offline.
.sp
-All other subcommands are intended to be run “offline”. However, especially
+All other subcommands are intended to be run \(dqoffline\(dq. However, especially
when testing, it is of course possible to run the subcommands online as well.
Generally, subcommands read inputs (beyond command\-line arguments)
from \fBstdin\fP\&. However, they may also consume outputs of previous
@@ -68,45 +68,47 @@ and if not consumed the final output is printed to \fBstdout\fP\&.
The general options for \fBtaler\-auditor\-offline\fP are:
.INDENT 0.0
.TP
-\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP‌\fIFILENAME\fP
+\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP‌\fIFILENAME\fP
Use the configuration and other resources for the merchant to operate
from \fIFILENAME\fP\&.
.TP
-\fB\-h\fP | \fB–help\fP
+\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
-\fB\-L\fP \fILOGLEVEL\fP | \fB–loglevel=\fP‌\fILOGLEVEL\fP
+\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP‌\fILOGLEVEL\fP
Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
\fBWARNING\fP, \fBERROR\fP\&.
.TP
-\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP‌\fIFILENAME\fP
+\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP‌\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
-\fB\-v\fP | \fB–version\fP
+\fB\-v\fP | \fB\-\-version\fP
Print version information.
.UNINDENT
.SH CONFIGURATION
.sp
The exchange and the \fBtaler\-auditor\-httpd\fP must both be provided with
-the auditor’s public key, such that they can validate messages signed
-by the auditor. To obtain the auditor’s public key, use:
+the auditor\(aqs public key, such that they can validate messages signed
+by the auditor. To obtain the auditor\(aqs public key, use:
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline setup
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.sp
Note that if the private key file already exists, the above will simply output
-the existing key. Passing additional arguments after setup (including “\-“)
+the existing key. Passing additional arguments after setup (including \(dq\-\(dq)
will cause the output to be encapsulated in JSON.
.sp
Relevant configuration options for \fBtaler\-auditor\-offline\fP are:
.INDENT 0.0
.IP \(bu 2
-\fB[auditor/AUDITOR_PRIV_FILE]\fP — where to store the private key
+\fB[auditor/AUDITOR_PRIV_FILE]\fP \-\-\- where to store the private key
.UNINDENT
.SH SUBCOMMANDS
.SS setup
@@ -157,36 +159,44 @@ required arguments.
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline download > keys.json
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.SS Show information about public keys (offline or online)
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline show < keys.json
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.SS Sign public keys (offline)
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline sign < keys.json > sigs.json
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.SS Upload auditor signatures (online)
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline upload < sigs.json
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.SS Download, sign and upload, all in one (online)
@@ -195,9 +205,11 @@ Note that doing this is only recommended in non\-production deployments.
.INDENT 0.0
.INDENT 3.5
.sp
-.EX
+.nf
+.ft C
$ taler\-auditor\-offline download sign upload
-.EE
+.ft P
+.fi
.UNINDENT
.UNINDENT
.SH SECURITY CONSIDERATIONS