gnunet-svn
[Top][All Lists]
Advanced

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

[taler-docs] branch master updated (acc18e8 -> 4d9275f)


From: gnunet
Subject: [taler-docs] branch master updated (acc18e8 -> 4d9275f)
Date: Fri, 18 Dec 2020 09:54:08 +0100

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

ttn pushed a change to branch master
in repository docs.

    from acc18e8  format ‘console’ code blocks (five instances)
     new 554b130  add hyphen between ‘command’ and ‘line’
     new b1de708  add hyphen between ‘command’ and ‘line’
     new 29281a3  use ellipses instead of * to indicate "zero or more"
     new fe99f70  use `` and `` to mark up subcommands, instead of " and " (22 
instances)
     new 8bd772c  mark up ‘stdin’ and ‘stdout’ (10 instances)
     new 1ff7214  mark up ‘FILENAME’
     new 4d9275f  mark up ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’

The 7 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  |  2 +-
 manpages/taler-exchange-offline.1.rst | 62 +++++++++++++++++------------------
 2 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/manpages/taler-auditor-offline.1.rst 
b/manpages/taler-auditor-offline.1.rst
index 001768c..75f4f73 100644
--- a/manpages/taler-auditor-offline.1.rst
+++ b/manpages/taler-auditor-offline.1.rst
@@ -23,7 +23,7 @@ Synopsis
 Description
 ===========
 
-**taler-auditor-offline** is a command line tool to be used by an auditor to
+**taler-auditor-offline** 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 coins of those denominations.  The tool takes a list
diff --git a/manpages/taler-exchange-offline.1.rst 
b/manpages/taler-exchange-offline.1.rst
index cdedd20..33d5761 100644
--- a/manpages/taler-exchange-offline.1.rst
+++ b/manpages/taler-exchange-offline.1.rst
@@ -14,46 +14,46 @@ Synopsis
 **taler-exchange-offline**
 [**-h** | **––help**]
 [**-v** | **––version**]
-[SUBCOMMANDS]*
+[subcommand ...]
 
 
 Description
 ===========
 
-**taler-exchange-offline** is a command line tool to interact with the Taler
+**taler-exchange-offline** is a command-line tool to interact with the Taler
 exchange's master private key. Most operations of this tool require access to
 the exchange’s long-term offline signing key and should be run in a secure
 (offline) environment under strict controls.  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 the future public keys from the
-running exchange.  The resulting data serves as input to the "sign" and "show"
-subcommands.  The "upload" subcommand uploads the signatures created with the
+REST APIs.  The ``download`` subcommand downloads the future public keys from 
the
+running exchange.  The resulting data serves as input to the ``sign`` and 
``show``
+subcommands.  The ``upload`` subcommand uploads the signatures created with the
 private master key to the exchange.  It handles the output of all subcommands
-(except "download").  The "download" and "upload" commands must naturally be
+(except ``download``).  The ``download`` and ``upload`` commands must 
naturally be
 run "online" and do not require access to the offline key.
 
 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-exchange-offline** are:
 
 **-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
    Use the configuration and other resources for the merchant to operate
-   from FILENAME.
+   from *FILENAME*.
 
 **-h** \| **––help**
    Print short help on options.
 
 **-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
-   Specifies the log level to use. Accepted values are: DEBUG, INFO,
-   WARNING, ERROR.
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
 
 **-o** *FILE* \| **––output=**\ ‌\ *FILE*
    Where to write a denomination key signing request file to be given to
@@ -98,7 +98,7 @@ download
 
 This command must be run online. It downloads future signing and denomination
 keys with the associated meta data from the exchange and outputs the resulting
-JSON (for consumption by subsequent commands, or to stdout).
+JSON (for consumption by subsequent commands, or to ``stdout``).
 
 
 show
@@ -108,11 +108,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.
 
 
@@ -121,11 +121,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
@@ -137,7 +137,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
@@ -149,7 +149,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.
 
 
 
@@ -176,10 +176,10 @@ The third argument must be a human-readable name for the 
auditor. This may
 be shown to users and should identify the auditor's business entity.  If
 the name includes spaces, the argument should be quoted.
 
-The subcommand takes no inputs from stdin or other subcommands.
+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
@@ -192,10 +192,10 @@ tool.
 The auditor's public key must be given in the usual base32-encoding as the
 first argument.
 
-The subcommand takes no inputs from stdin or other subcommands.
+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
@@ -213,10 +213,10 @@ front for the actual internal business acounts.
 The payto:// URI (RFC 8905) of the exchange's bank account must be given
 as the first argument to the subcommand.
 
-The subcommand takes no inputs from stdin or other subcommands.
+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
@@ -228,10 +228,10 @@ belonging to the exchange on its ``/wire`` endpoint.
 The payto:// URI (RFC 8905) of the exchange's (former) bank account must be
 given as the first argument to the subcommand.
 
-The subcommand takes no inputs from stdin or other subcommands.
+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
@@ -249,16 +249,16 @@ Instead of a year, the string ``now`` can be given for 
the current year
 GANA registry as given in RFC 8905.  The fees must be given in the usual
 Taler format of ``CURRENCY:NUMBER.FRACTION``.
 
-The subcommand takes no inputs from stdin or other subcommands.
+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.
 
@@ -332,7 +332,7 @@ $ taler-exchange-offline revoke-denomination $DKH1 
revoke-denomination $DKH2 > r
 $ taler-exchange-offline revoke-signkey $SK1 revoke-signkey $SK2 > revoke.json
 $ taler-exchange-offline revoke-signkey $SK revoke-denomkey $DKH > mix.json
 
-The outputs ("revoke.json", "mix.json") must be uploaded using the "upload"
+The outputs ("revoke.json", "mix.json") must be uploaded using the ``upload``
 command to the exchange to actually revoke the keys.
 
 

-- 
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]