gnunet-svn
[Top][All Lists]
Advanced

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

[taler-docs] 02/05: taler-merchant-setup-reserve(1): rewrite opts descri


From: gnunet
Subject: [taler-docs] 02/05: taler-merchant-setup-reserve(1): rewrite opts descriptions
Date: Fri, 08 Jan 2021 05:19:55 +0100

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

ttn pushed a commit to branch master
in repository docs.

commit d21153975cee1b3f7cc33e45d7fa1548c5e09c60
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Thu Jan 7 23:11:26 2021 -0500

    taler-merchant-setup-reserve(1): rewrite opts descriptions
    
    - omit "Optional."
    - move "Mandatory." to first sentence
    - refill
    - mark up arg names
---
 manpages/taler-merchant-setup-reserve.1.rst | 51 ++++++++++++++++++-----------
 1 file changed, 32 insertions(+), 19 deletions(-)

diff --git a/manpages/taler-merchant-setup-reserve.1.rst 
b/manpages/taler-merchant-setup-reserve.1.rst
index 9cfaba6..317c340 100644
--- a/manpages/taler-merchant-setup-reserve.1.rst
+++ b/manpages/taler-merchant-setup-reserve.1.rst
@@ -27,43 +27,56 @@ from the exchange needed to fill the reserve.
 Options
 =======
 
-**-a** *VALUE* \| **––amount=**\ \ *VALUE*
-   Amount to be transferred to the reserve. Mandatory.
-
 **-A** *USERNAME:PASSWORD* \| **––auth=**\ \ *USERNAME:PASSWORD*
-   Use USERNAME and PASSWORD for HTTP client authentication. The ":" must be 
present as a separator. Note that this form of authentication has nothing to do 
with the TLS client certificate authentication supported with the "-C", "-k" 
and "-p" options.  The PASSWORD given to this option is given to the server! 
Optional.
+   Use ``USERNAME`` and ``PASSWORD`` for HTTP client authentication.
+   The ":" must be present as a separator.
+   Note that this form of authentication has nothing to do with the TLS client
+   certificate authentication supported with the ``-C``, ``-k`` and ``-p`` 
options.
+   The ``PASSWORD`` given to this option is given to the server!
+
+**-a** *VALUE* \| **––amount=**\ \ *VALUE*
+   Mandatory.
+   Amount to be transferred to the reserve.
 
 **-C** *CERTFILE* \| **––cert=**\ \ *CERTFILE*
-   The specified CERTFILE contains a TLS client certificate to be used to 
authenticate the client. Optional.  See also "-t".
+   The specified ``CERTFILE`` contains a TLS client certificate to be used to
+   authenticate the client. See also ``-t``.
 
 **-e** *URL* \| **––exchange-url=**\ \ *URL*
-   Use URL for the exchange base URL. This is the exchange where
-   the reserve will be created. The currency used in the amount
-   specification must be offered by this exchange.  Mandatory.
+   Mandatory.
+   Use ``URL`` for the exchange base URL.
+   This is the exchange where the reserve will be created.
+   The currency used in the amount specification must be offered by this 
exchange.
 
 **-k** *KEYFILE* \| **––key=**\ \ *KEYFILE*
-   The specified KEYFILE contains a TLS client private key to be used to 
authenticate the client. Optional.  See also "-p" and "-C".
+   The specified ``KEYFILE`` contains a TLS client private key to be used to
+   authenticate the client. See also ``-p`` and ``-C``.
 
 **-m** *URL* \| **––merchant-url=**\ \ *URL*
-   Use URL as the merchant base URL.  Should include the path to
-   the instance if the reserve is to be created for a non-default instance.
    Mandatory.
+   Use ``URL`` as the merchant base URL.
+   Should include the path to the instance if the reserve is to be
+   created for a non-default instance.
 
 **-p** *KEYFILEPASSPHRASE* \| **––pass=**\ \ *KEYFILEPASSPHRASE*
-   The specified KEYFILEPASSPHRASE is to be used to decrypt the KEYFILE. 
Optional.  See also "-k". Not to be confused with "-A".  The KEYFILEPASSPHRASE 
given here is only used locally to decrypt the KEYFILE.
+   The specified ``KEYFILEPASSPHRASE`` is to be used to decrypt the KEYFILE.
+   See also ``-k``. Not to be confused with ``-A``.
+   The ``KEYFILEPASSPHRASE`` given here is only used locally to decrypt the 
KEYFILE.
 
 **-t** *CERTTYPE* \| **––type=**\ \ *CERTTYPE*
-   The specified CERTFILE contains a TLS client certificate of CERTTYPE. 
Default is "PEM". Optional.  See also "-C".
+   The specified CERTFILE contains a TLS client certificate of ``CERTTYPE``.
+   Default is ``PEM``. See also ``-C``.
 
 **-w** *METHOD* \| **––wire-method=**\ \ *METHOD*
-   Which wire method should be used. Needed to select the wire
-   transfer method of the exchange. The method must be supported
-   by the exchange. Typical values would be "iban" or "x-taler-bank".
    Mandatory.
+   Which wire method should be used.
+   Needed to select the wire transfer method of the exchange.
+   The method must be supported by the exchange.
+   Typical values would be ``iban`` or ``x-taler-bank``.
 
 **-c** *FILENAME* \| **––config=**\ \ *FILENAME*
    Use the configuration and other resources for the merchant to
-   operate from FILENAME.
+   operate from ``FILENAME``.
 
 **-h** \| **––help**
    Print short help on options.
@@ -72,10 +85,10 @@ Options
    Print version information.
 
 **-l** *LF* \| **––logfile=**\ \ *LF*
-   Sends logs to file whose path is LF.
+   Sends logs to file whose path is ``LF``.
 
 **-L** *LOGLEVEL* \| **––log=**\ \ *LOGLEVEL*
-   Use loglevel LOGLEVEL.
+   Use loglevel ``LOGLEVEL``.
 
 
 See Also

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