From 8410336d954688c88014576ba0f3fea905b29b39 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Wed, 6 Jul 2022 22:52:55 +0200 Subject: -update prebuilt documentation --- man/taler-auditor-offline.1 | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'man/taler-auditor-offline.1') diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1 index ef1c81f3..7993f4f8 100644 --- a/man/taler-auditor-offline.1 +++ b/man/taler-auditor-offline.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-OFFLINE" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-OFFLINE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange . @@ -33,12 +33,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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\(aqs +The tool includes two subcommands to interact \fIonline\fP with the exchange’s 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\(aqs private key, which should be kept offline. +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. .sp -All other subcommands are intended to be run "offline". However, especially +All other subcommands are intended to be run “offline”. 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,28 +68,28 @@ 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\(aqs public key, such that they can validate messages signed -by the auditor. To obtain the auditor\(aqs public key, use: +the auditor’s public key, such that they can validate messages signed +by the auditor. To obtain the auditor’s public key, use: .INDENT 0.0 .INDENT 3.5 .sp @@ -102,13 +102,13 @@ $ taler\-auditor\-offline setup .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 “\-“) 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 -- cgit v1.2.3