commit f7836f5bf9010c7546fb132fdcc6659072729f5a
parent dedcfc666173b1782381b7a880d1e68ccaadfe87
Author: Christian Grothoff <christian@grothoff.org>
Date: Fri, 8 Mar 2024 23:16:15 +0100
document 'display-hint' option to taler-exchange-offline
Diffstat:
1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/manpages/taler-exchange-offline.1.rst b/manpages/taler-exchange-offline.1.rst
@@ -277,6 +277,14 @@ Afterwards, optional arguments can be given:
REST API that allows merchants and wallets to determine the current
conversion rate.
+ * ``display-hint`` $PRIORITY $LABEL: specifies that this bank account should
+ be shown to the user with the given numeric $PRIORITY (higher is earlier)
+ and with the given $LABEL. This is useful to ensure that if an exchange
+ has multiple bank accounts, we can show the user those that are most likely
+ useful first, and give them appropriately labeled hints for selecting other
+ accounts as well. A display hint is optional, if missing the priority is 0
+ and the wallet must pick some appropriate label itself somehow.
+
* ``credit-restriction`` $TYPE [$ARGS]: Specifies that there are
restrictions in place when crediting this bank account. Details depend on
the restriction $TYPE. This argument may be given multiple times, in which
