Update payment generator instructions.

1 files changed, 45 insertions, 32 deletions

diff --git a/src/merchant-tools/README b/src/merchant-tools/README
index 596d5da8..cb568a21 100644
--- a/src/merchant-tools/README
+++ b/src/merchant-tools/README
@@ -12,35 +12,48 @@ about the setup to target. Note that the merchant and the exchange
 run by this command will use their own config files, so just few values
 are required for it to run.
 
-
-=== COFIGURATION ===
-
-Any config file must look like the following one.
-
-[payments-generator]
-
-# where on this machine the exchange listens; note that
-# this exchange must be among the ones accepted by the
-# merchant
-exchange = http://localexchange/
-
-# where on this machine the merchant listens
-merchant = http://localshop/
-
-# bank's URL of the customer who withdraws coins.
-# Must be known by the exchange.
-bank = http://localbank/
-
-# must match an instance known by the merchant
-instance = FSF
-
-# must match the currency used by merchant and exchange
-currency = EUR
-
-
-=== INVOCATION ===
-
-taler-merchant-generate-payments -c config/file.conf [-n ITERATIONS]
-
-The -n option instructs the tool about how many iterations of all
-the (internal) commands we want to execute.
+=== RUNNING IT ===
+
+The payment generator takes all the input from the command line.
+It comes with two subcommands: 'ordinary' and 'corner'.  The first
+performs "ordinary" payments (payments that are supposed to get
+through), whereas the second does less usual cases, with unaggregated
+payments or non default instances.
+
+The usual --help option is provided, so the following command will
+show, for instance, all the available options for the 'corner' switch.
+  
+  $ taler-merchant-benchmark corner --help
+
+Here is the output:
+
+  taler-merchant-benchmark
+  Populate databases with corner case payments
+  Arguments mandatory for long options are also mandatory for short options.
+    -h, --help                 print this help
+    -L, --log=LOGLEVEL         configure logging to use LOGLEVEL
+    -u, --unaggregated-number=UN
+                               will generate UN unaggregated payments, defaults
+                                 to 1
+    -t, --two-coins=TC         will perform TC 2-coins payments, defaults to 1
+    -m, --merchant-url=MU      merchant base url, mandatory
+    -i, --alt-instance=AI      alternative (non default) instance, used to
+                                 provide fresh wire details to make unaggregated
+                                 transactions stay so. Note, this instance will
+                                 be given far future wire deadline, and so it
+                                 should never author now-deadlined transactions,
+                                 as they would get those far future ones
+                                 aggregated too.
+    -b, --bank-url=BU          bank base url, mandatory
+    -l, --logfile=LF           will log to file LF
+  Report bugs to taler@gnu.org.
+  GNUnet home page: http://www.gnu.org/s/taler/
+  General help using GNU software: http://www.gnu.org/gethelp/
+
+The most important (and mandatory) arguments are --bank-url,
+and --merchant-url.  The first is used by the generator to launch
+the bank; in particular, the generator tests that the bank is
+actually serving that URL.  The second argument is used by the
+generator to reach the merchant, in order to get and pay for contracts.
+
+Feel free to issue the --help option for the 'ordinary' subcommand as well!