gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated (0cc41c0 -> 002f0b0)


From: gnunet
Subject: [taler-docs] branch master updated (0cc41c0 -> 002f0b0)
Date: Fri, 18 Dec 2020 08:51:43 +0100

This is an automated email from the git hooks/post-receive script.

ttn pushed a change to branch master
in repository docs.

    from 0cc41c0  address ttn comments
     new 5d4114c  use `` and `` to mark up subcommands, instead of " and " (25 
instances)
     new 3b23904  use ellipses instead of * to indicate "zero or more"
     new 002f0b0  use `` and `` to mark up std{in,out}, instead of LaTeX \tt

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 manpages/taler-auditor-offline.1.rst | 46 ++++++++++++++++++------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/manpages/taler-auditor-offline.1.rst 
b/manpages/taler-auditor-offline.1.rst
index 3ee3b7d..4d4ddbc 100644
--- a/manpages/taler-auditor-offline.1.rst
+++ b/manpages/taler-auditor-offline.1.rst
@@ -14,7 +14,7 @@ Synopsis
 **taler-auditor-offline**
 [**-h** | **––help**]
 [**-v** | **––version**]
-[SUBCOMMANDS]*
+[subcommand ...]
 
 
 Description
@@ -27,22 +27,22 @@ 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
 when testing, it is of course possible to run the commands online as well.
 Generally, subcommands read inputs (beyond command-line arguments)
-from {\tt stdin}. However, they may also consume outputs of previous
+from ``stdin``. However, they may also consume outputs of previous
 subcommands.  The outputs of multiple commands is automatically combined,
-and if not consumed the final output is printed to {\tt stdout}.
+and if not consumed the final output is printed to ``stdout``.
 
 
 The general options to for **taler-auditor-offline** are:
@@ -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

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]