summaryrefslogtreecommitdiff
path: root/manpages/taler-auditor-exchange.1.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
committerFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
commit5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10 (patch)
tree5f75fd693a1d062c7e5702f30c466c24a90e0fe2 /manpages/taler-auditor-exchange.1.rst
parentaf61db1b78f82241163861a5770d67e2442ef803 (diff)
downloaddocs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.gz
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.bz2
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.zip
manpages live here now
Diffstat (limited to 'manpages/taler-auditor-exchange.1.rst')
-rw-r--r--manpages/taler-auditor-exchange.1.rst60
1 files changed, 60 insertions, 0 deletions
diff --git a/manpages/taler-auditor-exchange.1.rst b/manpages/taler-auditor-exchange.1.rst
new file mode 100644
index 0000000..b7ef1d2
--- /dev/null
+++ b/manpages/taler-auditor-exchange.1.rst
@@ -0,0 +1,60 @@
+taler-auditor-exchange(1)
+##########################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-auditor-exchange** - add or remove exchange from auditor’s list
+
+Synopsis
+========
+
+**taler-auditor-exchange** [**-h** | **--help**] [**-r** | **--remove**]
+[**-m** *MASTERKEY* | **--exchange-key=**\ ‌\ *MASTERKEY*]
+[**-u** *EXCHANGE_URL* | **--auditor-url=**\ ‌\ *EXCHANGE_URL*]
+
+Description
+===========
+
+**taler-auditor-exchange** is a command line tool to be used by an
+auditor to add or remove an exchange from the list of exchange’s audited
+by the auditor. You must add an exchange to that list before signing
+denomination keys with taler-auditor-sign or trying to audit it with
+taler-auditor or taler-wire-auditor. Afterwards the exchange will be
+visible via the /exchanges API of the taler-auditor-httpd.
+
+**-m** *MASTERKEY* \| **--exchange-key=**\ ‌\ *MASTERKEY*
+ Public key of the exchange in Crockford base32 encoding, for example
+ as generated by gnunet-ecc -p.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-u** *EXCHANGE_URL* \| **--auditor-url=**\ ‌\ *EXCHANGE_URL*
+ URL of the exchange. The exchange’s HTTP API must be available at
+ this address.
+
+**-r** \| **--remove**
+ Instead of adding the exchange, remove it. Note that this will drop
+ ALL data associated with that exchange, including existing auditing
+ information. So use with extreme care!
+
+See Also
+========
+
+gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5)
+
+Bugs
+====
+
+We should optionally verify the correctness of this exchange’s base URL
+and that it matches the master public key (note that the exchange may
+still be offline, so it should be possible to bypass such a verfication
+step). Furthermore, if we do verification, as a (less secure)
+convenience option, we should make **-** m optional and obtain it from
+the base URL.
+
+Report bugs by using https://gnunet.org/bugs/ or by sending electronic
+mail to <taler@gnu.org>. \ No newline at end of file