summaryrefslogtreecommitdiff
path: root/manpages/taler-auditor-offline.1.rst
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2020-12-18 02:47:37 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2020-12-18 02:47:37 -0500
commit5d4114c21bbe327aaae584dcf331363e3a7d99d4 (patch)
tree4b48f3b044a53d22283b66e93d89c11cec3b2250 /manpages/taler-auditor-offline.1.rst
parent0cc41c007f771f5bf8897e39565e426b44cfd7c1 (diff)
downloaddocs-5d4114c21bbe327aaae584dcf331363e3a7d99d4.tar.gz
docs-5d4114c21bbe327aaae584dcf331363e3a7d99d4.tar.bz2
docs-5d4114c21bbe327aaae584dcf331363e3a7d99d4.zip
use `` and `` to mark up subcommands, instead of " and " (25 instances)
Diffstat (limited to 'manpages/taler-auditor-offline.1.rst')
-rw-r--r--manpages/taler-auditor-offline.1.rst40
1 files changed, 20 insertions, 20 deletions
diff --git a/manpages/taler-auditor-offline.1.rst b/manpages/taler-auditor-offline.1.rst
index 3ee3b7d..7b376af 100644
--- a/manpages/taler-auditor-offline.1.rst
+++ b/manpages/taler-auditor-offline.1.rst
@@ -27,14 +27,14 @@ properly accounting for coins of those denominations. The tool takes a list
of subcommands as arguments which are then processed sequentially.
The tool includes two subcommands to interact *online* with the exchange's
-REST APIs. The "download" subcommand downloads current public keys from the
+REST APIs. The ``download`` subcommand downloads current public keys from the
running exchange. Note that this only includes keys that the exchange
operator has previously validated using the **taler-exchange-offline** tool.
-The resulting data serves as input to the "sign" and "show" subcommands.
+The resulting data serves as input to the ``sign`` and ``show`` subcommands.
-The "upload" subcommand uploads the signatures created with the private key to
-the exchange. It handles the output of all subcommands (except "download").
-The "download" and "upload" commands must naturally be run "online" and do not
+The ``upload`` subcommand uploads the signatures created with the private key to
+the exchange. It handles the output of all subcommands (except ``download``).
+The ``download`` and ``upload`` commands must naturally be run "online" and do not
require access to the auditor's private key, which should be kept offline.
All other subcommands are intended to be run "offline". However, especially
@@ -111,11 +111,11 @@ This command outputs information about future signing and denomination keys for
manual checking against the business-approved fee structure, lifetimes and
other parameters.
-It consumes the output of the "download" subcommand, either from "stdin" or
+It consumes the output of the ``download`` subcommand, either from ``stdin`` or
directly.
-Its output always goes to "stdout" for human consumption (not in JSON). It
-is usually a bad idea (but possible) to combine "show" with other commands,
+Its output always goes to ``stdout`` for human consumption (not in JSON). It
+is usually a bad idea (but possible) to combine ``show`` with other commands,
except maybe for testing.
@@ -124,11 +124,11 @@ sign
This command signs information about future signing and denomination keys.
-It consumes the output of the "download" subcommand, either from "stdin" or
+It consumes the output of the ``download`` subcommand, either from ``stdin`` or
directly.
It outputs the signatures over *all* denomination and signing keys
-present in the input, in a format suitable for the "upload" subcommand.
+present in the input, in a format suitable for the ``upload`` subcommand.
revoke-denomination
@@ -140,7 +140,7 @@ The hash of the denomination public key must be given in the usual
base32-encoding as the first and only argument to the subcommand.
It outputs the signature affirming the revocation of the denomination key,
-in a format suitable for the "upload" subcommand.
+in a format suitable for the ``upload`` subcommand.
revoke-signkey
@@ -152,7 +152,7 @@ The online signing public key must be given in the usual
base32-encoding as the first and only argument to the subcommand.
It outputs the signature affirming the revocation of the online signing key,
-in a format suitable for the "upload" subcommand.
+in a format suitable for the ``upload`` subcommand.
@@ -182,7 +182,7 @@ the name includes spaces, the argument should be quoted.
The subcommand takes no inputs from stdin or other subcommands.
It outputs the signature affirming the addition of the auditor,
-in a format suitable for the "upload" subcommand.
+in a format suitable for the ``upload`` subcommand.
disable-auditor
@@ -198,7 +198,7 @@ first argument.
The subcommand takes no inputs from stdin or other subcommands.
It outputs the signature affirming the removal of the auditor,
-in a format suitable for the "upload" subcommand.
+in a format suitable for the ``upload`` subcommand.
enable-account
@@ -219,7 +219,7 @@ as the first argument to the subcommand.
The subcommand takes no inputs from stdin or other subcommands.
It outputs the signature affirming the addition of the wire account,
-in a format suitable for the "upload" subcommand.
+in a format suitable for the ``upload`` subcommand.
disable-account
@@ -234,7 +234,7 @@ given as the first argument to the subcommand.
The subcommand takes no inputs from stdin or other subcommands.
It outputs the signature affirming the deletion of the wire account, in a
-format suitable for the "upload" subcommand.
+format suitable for the ``upload`` subcommand.
wire-fee
@@ -255,13 +255,13 @@ Taler format of ``CURRENCY:NUMBER.FRACTION``.
The subcommand takes no inputs from stdin or other subcommands.
It outputs the signature affirming the wire fees, in a format suitable for the
-"upload" subcommand.
+``upload`` subcommand.
upload
------
-This subcommand uploads outputs from other commands (except "download" and "show")
+This subcommand uploads outputs from other commands (except ``download`` and ``show``)
to the exchange. Note that it is possible that some uploads succeed, while others
fail, as the operation is not atomic.
@@ -313,9 +313,9 @@ Security considerations
=======================
The **taler-auditor-offline** tool assumes that it is run on a high-security
-system, especially for the "sign" command.
+system, especially for the ``sign`` command.
-The auditor should first use the "show" command on the offline system to
+The auditor should first use the ``show`` command on the offline system to
check that the keys being signed are acceptable. This process requires
manual work: the auditor should check with the exchange operator that
the keys (and meta data) matches that previously seen by the