[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 04/07: use `` and `` to mark up subcommands, instead of " a
From: |
gnunet |
Subject: |
[taler-docs] 04/07: use `` and `` to mark up subcommands, instead of " and " (22 instances) |
Date: |
Fri, 18 Dec 2020 09:54:12 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
commit fe99f7014bf79c3559a15bee544bfc3f0517a69b
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Fri Dec 18 03:47:00 2020 -0500
use `` and `` to mark up subcommands, instead of " and " (22 instances)
---
manpages/taler-exchange-offline.1.rst | 36 +++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/manpages/taler-exchange-offline.1.rst
b/manpages/taler-exchange-offline.1.rst
index 729ad77..9defae9 100644
--- a/manpages/taler-exchange-offline.1.rst
+++ b/manpages/taler-exchange-offline.1.rst
@@ -27,11 +27,11 @@ the exchange’s long-term offline signing key and should be
run in a secure
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
@@ -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.
@@ -179,7 +179,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
@@ -195,7 +195,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
@@ -216,7 +216,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
@@ -231,7 +231,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
@@ -252,13 +252,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.
@@ -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.
- [taler-docs] branch master updated (acc18e8 -> 4d9275f), gnunet, 2020/12/18
- [taler-docs] 02/07: add hyphen between ‘command’ and ‘line’, gnunet, 2020/12/18
- [taler-docs] 01/07: add hyphen between ‘command’ and ‘line’, gnunet, 2020/12/18
- [taler-docs] 03/07: use ellipses instead of * to indicate "zero or more", gnunet, 2020/12/18
- [taler-docs] 06/07: mark up ‘FILENAME’, gnunet, 2020/12/18
- [taler-docs] 07/07: mark up ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’, gnunet, 2020/12/18
- [taler-docs] 04/07: use `` and `` to mark up subcommands, instead of " and " (22 instances),
gnunet <=
- [taler-docs] 05/07: mark up ‘stdin’ and ‘stdout’ (10 instances), gnunet, 2020/12/18