From 4d8429045362f3d4bf86e67a509347b03f2f8239 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 21 Mar 2020 15:49:48 +0100 Subject: update man pages --- conf.py | 2 ++ manpages/taler-auditor-dbinit.1.rst | 58 ++++++++++++++++++++++++++++++++ manpages/taler-auditor.1.rst | 10 ++---- manpages/taler-exchange-aggregator.1.rst | 5 ++- manpages/taler-exchange-closer.1.rst | 8 ++--- manpages/taler-exchange-dbinit.1.rst | 5 ++- manpages/taler-exchange-keycheck.1.rst | 3 +- manpages/taler-exchange-keyup.1.rst | 1 - manpages/taler-exchange-transfer.1.rst | 5 ++- 9 files changed, 74 insertions(+), 23 deletions(-) create mode 100644 manpages/taler-auditor-dbinit.1.rst diff --git a/conf.py b/conf.py index 51a848ba..4010d57b 100644 --- a/conf.py +++ b/conf.py @@ -272,6 +272,8 @@ man_pages = [ 1), ("manpages/taler-auditor-sign.1", "taler-auditor-sign", "sign exchange denomination as auditor", "GNU Taler contributors", 1), + ("manpages/taler-auditor-dbinit.1", "taler-auditor-dbinit", + "setup auditor database", "GNU Taler contributors", 1), ("manpages/taler-auditor.1", "taler-auditor", "audit exchange", "GNU Taler contributors", 1), ("manpages/taler-bank-transfer.1", "taler-bank-transfer", diff --git a/manpages/taler-auditor-dbinit.1.rst b/manpages/taler-auditor-dbinit.1.rst new file mode 100644 index 00000000..463814ac --- /dev/null +++ b/manpages/taler-auditor-dbinit.1.rst @@ -0,0 +1,58 @@ +taler-auditor-dbinit(1) +####################### + +.. only:: html + + Name + ==== + + **taler-auditor-dbinit** - initialize Taler auditor database + + +Synopsis +======== + +**taler-auditor-dbinit** +[**-h** | **–help**] [**-g** | **–gc**] [**-R** | **–reset**] [**-r** | **–restart**] +[**-v** | **–version**] + +Description +=========== + +**taler-exchange-dbinit** is a command line tool to initialize the Taler +exchange database. It creates the necessary tables and indices for the +Taler exchange to operate. + +Its options are as follows: + +**-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* + Use the configuration and other resources for the exchange to operate + from *FILENAME*. + +**-h** \| **–help** + Print short help on options. + +**-g** \| **–gc** + Garbage collect database. Deletes all unnecessary data in the + database. + +**-R** \| **–reset** + Drop tables. Dangerous, will delete all existing data in the database. + +**-r** \| **--restart** + Restart all auditors from the beginning. Useful for + testing. + +**-v** \| **–version** + Print version information. + +See Also +======== + +taler-auditor-httpd(1), taler-auditor(1), taler.conf(5). + +Bugs +==== + +Report bugs by using https://bugs.gnunet.org or by sending electronic +mail to . diff --git a/manpages/taler-auditor.1.rst b/manpages/taler-auditor.1.rst index e3742d94..d8ee1a96 100644 --- a/manpages/taler-auditor.1.rst +++ b/manpages/taler-auditor.1.rst @@ -13,7 +13,7 @@ Synopsis **taler-auditor** [**-h** | **--help**] [**-m** *MASTER_KEY* | **--exchange-key=**\ ‌\ *MASTER_KEY*] -[**-r** | **--reset**] + Description =========== @@ -37,16 +37,12 @@ matches the exchange’s database. Its options are as follows. taler-auditor will use the MASTER_PUBLIC_KEY value from the “exchange” section of the configuration. -**-r** \| **--reset** - Reset the audit, starts everything from the beginning. Useful for - testing and required for the first audit to setup auditor’s tables. - Note that if (just) the exchange key changes, the **-r** option - should not be used again. + See Also ======== -gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5) +gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5), taler-auditor-dbinit(1) Bugs ==== diff --git a/manpages/taler-exchange-aggregator.1.rst b/manpages/taler-exchange-aggregator.1.rst index e76e129c..255e1e14 100644 --- a/manpages/taler-exchange-aggregator.1.rst +++ b/manpages/taler-exchange-aggregator.1.rst @@ -12,7 +12,6 @@ Synopsis ======== **taler-exchange-aggregator** -[**-d** *DIRNAME* | **--exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **--help**] [**-t** | **--test**] [**-v** | **--version**] Description @@ -22,9 +21,9 @@ Description to the same merchant into larger wire transfers. The actual transfers are then done by **taler-exchange-transfer**. -**-d** *DIRNAME* \| **--exchange-dir=**\ ‌\ *DIRNAME* +**-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* Use the configuration and other resources for the exchange to operate - from *DIRNAME*. + from *FILENAME*. **-h** \| **--help** Print short help on options. diff --git a/manpages/taler-exchange-closer.1.rst b/manpages/taler-exchange-closer.1.rst index a1ab67c3..8783cd61 100644 --- a/manpages/taler-exchange-closer.1.rst +++ b/manpages/taler-exchange-closer.1.rst @@ -1,5 +1,5 @@ taler-exchange-closer(1) -############################ +######################### .. only:: html @@ -12,7 +12,6 @@ Synopsis ======== **taler-exchange-closer** -[**-d** *DIRNAME* | **--exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **--help**] [**-t** | **--test**] [**-v** | **--version**] Description @@ -22,9 +21,10 @@ Description reserves that have been idle for too long, causing transfers to the originating bank account to be scheduled. -**-d** *DIRNAME* \| **--exchange-dir=**\ ‌\ *DIRNAME* + +**-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* Use the configuration and other resources for the exchange to operate - from *DIRNAME*. + from *FILENAME*. **-h** \| **--help** Print short help on options. diff --git a/manpages/taler-exchange-dbinit.1.rst b/manpages/taler-exchange-dbinit.1.rst index b693e7fc..6d9b787b 100644 --- a/manpages/taler-exchange-dbinit.1.rst +++ b/manpages/taler-exchange-dbinit.1.rst @@ -13,7 +13,6 @@ Synopsis ======== **taler-exchange-dbinit** -[**-d** *DIRNAME* | **–exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **–help**] [**-g** | **–gc**] [**-r** | **–reset**] [**-v** | **–version**] @@ -26,9 +25,9 @@ Taler exchange to operate. Its options are as follows: -**-d** *DIRNAME* \| **–exchange-dir=**\ ‌\ *DIRNAME* +**-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* Use the configuration and other resources for the exchange to operate - from *DIRNAME*. + from *FILENAME*. **-h** \| **–help** Print short help on options. diff --git a/manpages/taler-exchange-keycheck.1.rst b/manpages/taler-exchange-keycheck.1.rst index 6694fda0..3f7b0352 100644 --- a/manpages/taler-exchange-keycheck.1.rst +++ b/manpages/taler-exchange-keycheck.1.rst @@ -13,7 +13,6 @@ Synopsis ======== **taler-exchange-keycheck** -[**-d** *DIRNAME* | **–exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **–help**] [**-v** | **–version**] Description @@ -27,7 +26,7 @@ that the files are correct. Its options are as follows: **-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* - Use the configuration and other resources for the merchant to operate + Use the configuration and other resources for the exchange to operate from *FILENAME*. **-h** \| **–help** diff --git a/manpages/taler-exchange-keyup.1.rst b/manpages/taler-exchange-keyup.1.rst index 4ba6bf3b..cab075a7 100644 --- a/manpages/taler-exchange-keyup.1.rst +++ b/manpages/taler-exchange-keyup.1.rst @@ -13,7 +13,6 @@ Synopsis ======== **taler-exchange-keyup** -[**-d** *DIRNAME* | **–exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **–help**] [**-m** *FILE* | **–master-key=**\ ‌\ *FILE*] [**-o** *FILE* | **–output=**\ ‌\ *FILE*] [**-r** *DKH* | **–revoke=**\ ‌\ *DKH*] diff --git a/manpages/taler-exchange-transfer.1.rst b/manpages/taler-exchange-transfer.1.rst index 78427a2d..4dac3625 100644 --- a/manpages/taler-exchange-transfer.1.rst +++ b/manpages/taler-exchange-transfer.1.rst @@ -12,7 +12,6 @@ Synopsis ======== **taler-exchange-transfer** -[**-d** *DIRNAME* | **--exchange-dir=**\ ‌\ *DIRNAME*] [**-h** | **--help**] [**-t** | **--test**] [**-v** | **--version**] Description @@ -21,9 +20,9 @@ Description **taler-exchange-transfer** is a command line tool to actually execute scheduled wire transfers (using the bank/wire gateway). The transfers are prepared by the **taler-exchange-aggregator** and **taler-exchange-closer** tools. -**-d** *DIRNAME* \| **--exchange-dir=**\ ‌\ *DIRNAME* +**-c** *FILENAME* \| **–config=**\ ‌\ *FILENAME* Use the configuration and other resources for the exchange to operate - from *DIRNAME*. + from *FILENAME*. **-h** \| **--help** Print short help on options. -- cgit v1.2.3