summaryrefslogtreecommitdiff
path: root/manpages/taler-exchange-offline.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'manpages/taler-exchange-offline.1.rst')
-rw-r--r--manpages/taler-exchange-offline.1.rst71
1 files changed, 66 insertions, 5 deletions
diff --git a/manpages/taler-exchange-offline.1.rst b/manpages/taler-exchange-offline.1.rst
index 4641b416..f9a380ad 100644
--- a/manpages/taler-exchange-offline.1.rst
+++ b/manpages/taler-exchange-offline.1.rst
@@ -142,6 +142,47 @@ It outputs the signatures over *all* denomination and signing keys
present in the input, in a format suitable for the ``upload`` subcommand.
+extensions
+----------
+
+This subcommand is responsible for the management of available extensions in
+the exchange.
+
+It consumes the output of the ``download`` subcommand, either from ``stdin`` or
+directly.
+
+It provides the sub-subcommand ``extensions show`` to show the configuration
+for extensions and the ``extensions sign`` command to sign the current
+configuration of extensions, in a format suitable for the ``upload``
+subcommand.
+
+Note that an extension on the exchange will only become activated at runtime
+*after* the extension's configurations has been signed by the offline tool with
+the signing key and the signed configuration been uploaded to the exchange.
+
+drain
+-----
+
+This subcommand allows an exchange operator to transfer the
+profits made from transaction fees to a regular (non-escrowed) bank
+account. Using this command, draining profits from the
+escrow account can be done in such a way that the auditor
+is aware of the special transaction and does not flag the
+resulting balance as fundamentally problematic. Note that
+the drained amounts must still total up to less than the fees
+earned by the exchange.
+
+Arguments to the ``drain`` command are the amount to be drained (in the usual
+Taler amount format), the section of the exchange configuration specifying the
+account to be debited (this argument is currently ignored, and the account is
+purely derived from the wire method and the account being set for debiting),
+and finally the payto://-URI to wire the funds to.
+
+Note that to actually wire the funds, the exchange administrator must run
+**taler-exchange-drain** manually and confirm the operation after the
+``upload`` was completed.
+
+
revoke-denomination
-------------------
@@ -218,12 +259,12 @@ enable-account
--------------
This subcommand
-informs an exchange that it should advertize a bank account as belonging to
+informs an exchange that it should advertise a bank account as belonging to
the exchange on its ``/wire`` endpoint. Note that this does *not* ensure that
the exchange will use this bank account for incoming or outgoing wire
transfers! For this, the **taler-exchange-transfer** and
**taler-exchange-wirewatch** tools must be configured. Furthermore, the bank
-account information advertized could theoretically differ from that which
+account information advertised could theoretically differ from that which
these tool actually use, for example if the public bank account is only a
front for the actual internal business accounts.
@@ -255,13 +296,13 @@ format suitable for the ``upload`` subcommand.
wire-fee
--------
-This subcommand informs an exchange about the desired wire fee (and closing fee)
-structure for particular wire method and a calendar year (!). The tool does not
+This subcommand informs an exchange about the desired wire fee structure (that is, wire, and closing fees)
+for particular wire method and a calendar year (!). The tool does not
permit changing wire fees during a calendar year. Also, once the wire fee has been
set for a calendar year, it cannot be changed.
The subcommand takes the year, wire-method (see RFC 8905, examples include
-``x-taler-bank`` or ``iban``), wire fee and closing fee as arguments.
+``x-taler-bank`` or ``iban``), wire fee, and closing fee as arguments.
Instead of a year, the string ``now`` can be given for the current year
(this is mostly useful for test cases). The wire-method should follow the
GANA registry as given in RFC 8905. The fees must be given in the usual
@@ -273,6 +314,26 @@ It outputs the signature affirming the wire fees, in a format suitable for the
``upload`` subcommand.
+global-fee
+----------
+
+This subcommand informs an exchange about the desired global fee structure and
+related global configuration options for a calendar year (!). The tool does
+not permit changing global fees during a calendar year. Also, once the global
+fee structure has been set for a calendar year, it cannot be changed.
+
+The subcommand takes the year, history fee, account fee, purse fee,
+purse timeout, history expiration and the (free) purse (per)
+account limit as arguments. Instead of a year, the string ``now`` can be
+given for the current year (this is mostly useful for test cases). The fees
+must be given in the usual Taler format of ``CURRENCY:NUMBER.FRACTION``.
+
+The subcommand takes no inputs from ``stdin`` or other subcommands.
+
+It outputs the signature affirming the global fees, in a format suitable for
+the ``upload`` subcommand.
+
+
enable-partner
--------------