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

[gnunet]

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

ttn pushed a change to branch master
in repository docs.

    from 4d9275f  mark up ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’
     new cd722da  sync options in Synopsis w/ that in Description
     new 720dbe0  fix typo: s/to //
     new cdfddd8  format ‘console’ code blocks (12 instances)
     new 1b2dacc  mark up ‘[exchange/BASE_URL]’ plus two other similar
     new 70d5345  s/command/subcommand/ (12 instances)

The 5 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-exchange-offline.1.rst | 95 ++++++++++++++++++++++-------------
 1 file changed, 61 insertions(+), 34 deletions(-)

diff --git a/manpages/taler-exchange-offline.1.rst 
b/manpages/taler-exchange-offline.1.rst
index 33d5761..0ca0ddf 100644
--- a/manpages/taler-exchange-offline.1.rst
+++ b/manpages/taler-exchange-offline.1.rst
@@ -12,7 +12,10 @@ Synopsis
 ========
 
 **taler-exchange-offline**
+[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
 [**-h** | **––help**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+[**-o** *FILE* | **––output=**\ ‌\ *FILE*]
 [**-v** | **––version**]
 [subcommand ...]
 
@@ -31,18 +34,18 @@ REST APIs.  The ``download`` subcommand downloads the 
future public keys from th
 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`` subcommands 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.
+when testing, it is of course possible to run the subcommands online as well.
 Generally, subcommands read inputs (beyond command-line arguments)
 from ``stdin``. However, they may also consume outputs of previous
-subcommands.  The outputs of multiple commands is automatically combined,
+subcommands.  The outputs of multiple subcommands is automatically combined,
 and if not consumed the final output is printed to ``stdout``.
 
 
-The general options to for **taler-exchange-offline** are:
+The general options for **taler-exchange-offline** are:
 
 **-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
    Use the configuration and other resources for the merchant to operate
@@ -70,23 +73,27 @@ The exchange validates all operations by checking the 
signatures against the
 master public key that must be provided in the exchange configuration. To
 obtain the master public key, use:
 
-$ MASTER_PRIV_FILE=`taler-config -f -c $CONF -s EXCHANGE -o MASTER_PRIV_FILE`
-$ gnunet-ecc -p $MASTER_PRIV_FILE
+.. code-block:: console
+
+   $ MASTER_PRIV_FILE=`taler-config -f -c $CONF -s EXCHANGE -o 
MASTER_PRIV_FILE`
+   $ gnunet-ecc -p $MASTER_PRIV_FILE
 
 Note that if the private key file does not yet exist, the above will fail.
 In this case, create the private key using:
 
-$ MASTER_PRIV_FILE=`taler-config -f -c $CONF -s EXCHANGE -o MASTER_PRIV_FILE`
-$ MASTER_PRIV_DIR=`dirname $MASTER_PRIV_FILE`
-$ mkdir -p $MASTER_PRIV_DIR
-$ gnunet-ecc -g1 $MASTER_PRIV_FILE
+.. code-block:: console
+
+   $ MASTER_PRIV_FILE=`taler-config -f -c $CONF -s EXCHANGE -o 
MASTER_PRIV_FILE`
+   $ MASTER_PRIV_DIR=`dirname $MASTER_PRIV_FILE`
+   $ mkdir -p $MASTER_PRIV_DIR
+   $ gnunet-ecc -g1 $MASTER_PRIV_FILE
 
 
 Relevant configuration options for **taler-exchange-offline** are:
 
-* [exchange/BASE_URL] --- how to reach the exchange (for download/upload)
-* [exchange-offline/MASTER_PRIV_FILE] --- where to store the private keys
-* [exchange-offline/SECM_TOFU_FILE] --- where to store TOFU data
+* ``[exchange/BASE_URL]`` --- how to reach the exchange (for download/upload)
+* ``[exchange-offline/MASTER_PRIV_FILE]`` --- where to store the private keys
+* ``[exchange-offline/SECM_TOFU_FILE]`` --- where to store TOFU data
 
 
 
@@ -96,15 +103,15 @@ Subcommands
 download
 --------
 
-This command must be run online. It downloads future signing and denomination
+This subcommand 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 subcommands, or to ``stdout``).
 
 
 show
 ----
 
-This command outputs information about future signing and denomination keys for
+This subcommand outputs information about future signing and denomination keys 
for
 manual checking against the business-approved fee structure, lifetimes and
 other parameters.
 
@@ -112,14 +119,14 @@ 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,
+is usually a bad idea (but possible) to combine ``show`` with other 
subcommands,
 except maybe for testing.
 
 
 sign
 ----
 
-This command signs information about future signing and denomination keys.
+This subcommand signs information about future signing and denomination keys.
 
 It consumes the output of the ``download`` subcommand, either from ``stdin`` or
 directly.
@@ -131,7 +138,7 @@ present in the input, in a format suitable for the 
``upload`` subcommand.
 revoke-denomination
 -------------------
 
-This command signs a revocation message for a denomination key.
+This subcommand signs a revocation message for a denomination key.
 
 The hash of the denomination public key must be given in the usual
 base32-encoding as the first and only argument to the subcommand.
@@ -143,7 +150,7 @@ in a format suitable for the ``upload`` subcommand.
 revoke-signkey
 --------------
 
-This command signs a revocation message for an exchange online signing key.
+This subcommand signs a revocation message for an exchange online signing key.
 
 The online signing public key must be given in the usual
 base32-encoding as the first and only argument to the subcommand.
@@ -258,7 +265,7 @@ It outputs the signature affirming the wire fees, in a 
format suitable for the
 upload
 ------
 
-This subcommand uploads outputs from other commands (except ``download`` and 
``show``)
+This subcommand uploads outputs from other subcommands (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.
 
@@ -279,61 +286,81 @@ Examples
 Download future public keys from an exchange (online)
 -----------------------------------------------------
 
-$ taler-exchange-offline download > keys.json
+.. code-block:: console
+
+   $ taler-exchange-offline download > keys.json
 
 Show information about future public keys (offline or online)
 -------------------------------------------------------------
 
-$ taler-exchange-offline show < keys.json
+.. code-block:: console
+
+   $ taler-exchange-offline show < keys.json
 
 Sign future public keys (offline)
 ---------------------------------
 
-$ taler-exchange-offline sign < keys.json > sigs.json
+.. code-block:: console
+
+   $ taler-exchange-offline sign < keys.json > sigs.json
 
 Upload signatures about future public keys (online)
 ---------------------------------------------------
 
-$ taler-exchange-offline upload < sigs.json
+.. code-block:: console
+
+   $ taler-exchange-offline upload < sigs.json
 
 Download, sign and upload, all in one (online)
 ----------------------------------------------
 
 Note that doing this is only recommended in non-production deployments.
 
-$ taler-exchange-offline download sign upload
+.. code-block:: console
+
+   $ taler-exchange-offline download sign upload
 
 
 Create signature to enable bank account (offline)
 -------------------------------------------------
 
-$ taler-exchange-offline enable-account payto://iban/DE24242 > account.json
+.. code-block:: console
+
+   $ taler-exchange-offline enable-account payto://iban/DE24242 > account.json
 
 Upload bank account signature (online)
 --------------------------------------
 
-$ taler-exchange-offline upload < account.json
+.. code-block:: console
+
+   $ taler-exchange-offline upload < account.json
 
 
 Combine signing keys and enabling bank account (offline)
 --------------------------------------------------------
 
-$ taler-exchange-offline sign enable-account payto://iban/DE24242 < keys.json 
> combo.json
+.. code-block:: console
+
+   $ taler-exchange-offline sign enable-account payto://iban/DE24242 < 
keys.json > combo.json
 
 Upload various signatures (online)
 ----------------------------------
 
-$ taler-exchange-offline upload < combo.json
+.. code-block:: console
+
+   $ taler-exchange-offline upload < combo.json
 
 Create multiple revocation messages in one pass (offline)
 ---------------------------------------------------------
 
-$ taler-exchange-offline revoke-denomination $DKH1 revoke-denomination $DKH2 > 
revoke.json
-$ taler-exchange-offline revoke-signkey $SK1 revoke-signkey $SK2 > revoke.json
-$ taler-exchange-offline revoke-signkey $SK revoke-denomkey $DKH > mix.json
+.. code-block:: console
+
+   $ taler-exchange-offline revoke-denomination $DKH1 revoke-denomination 
$DKH2 > revoke.json
+   $ 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``
-command to the exchange to actually revoke the keys.
+subcommand to the exchange to actually revoke the keys.
 
 
 

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