From f019979799cfb918ce8ea35651dddc0f9039face Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 15 Jan 2018 15:40:27 +0100 Subject: patch for #5198 --- doc/Makefile.am | 1 - doc/manual.texi | 32 ++++++---------------------- doc/taler-merchant-tip-enable.1 | 47 ----------------------------------------- 3 files changed, 6 insertions(+), 74 deletions(-) delete mode 100644 doc/taler-merchant-tip-enable.1 (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 9481e41a..94c0ef44 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -12,7 +12,6 @@ arch.jpg: arch.dot AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css --css-ref=brown-paper.css man_MANS = \ - taler-merchant-tip-enable.1 \ taler-merchant-generate-payments.1 \ taler-merchant-httpd.1 diff --git a/doc/manual.texi b/doc/manual.texi index 3c7c3c07..b8e2c6c7 100644 --- a/doc/manual.texi +++ b/doc/manual.texi @@ -1125,36 +1125,16 @@ Make your wire transfer and (optionally) check at ``https://exchange:443/reserve/status/reserve_pub=QPE24X...'' whether your transfer has arrived at the exchange. @c FIXME: we should create a nicer tool to do this check! -Once the funds have arrived, you can now enable tipping using: -@example -$ taler-merchant-tip-enable \ - --amount=AMOUNT \ - --backend=BACKEND_URI \ - --credit-uuid=CREDIT_UUID \ - --instance=INSTANCE \ - --expiration=EXPIRATION -@end example -For ``AMOUNT'', specify the amount you transferred in the usual Taler -format of ``CURRENCY:VALUE[.FRACTION]'', i.e. ``EUR:50''. The -``BACKEND_URI'' should be the URI where your Taler merchant backend is -running. For ``CREDIT_UUID'', you need to specify a unique number -that identifies your wire transfer. You may have gotten one from your -bank, or you can just make one up! The important thing is that you -must never use the same UUID twice, except to repeat a failed command. -For INSTANCE, specify the backend instance (i.e. ``default''). -Finally, for EXPIRATION, pick a date two weeks after the wire -transfer, unless you know that the exchange that is being used has a -different period for closing reserves. The format @code{YYYY-MM-DD} -is accepted. - -Note that an exchange will typically close a reserve after two weeks, +Once the funds have arrived, you can start to use the reserve +for tipping. + +Note that an exchange will typically close a reserve after four weeks, wiring all remaining funds back to the sender's account. Thus, you should plan to wire funds corresponding to a campaign of about two weeks to the exchange initially. If your campaign runs longer, you -should wire further funds to the reserve every week to prevent it from -expiring. You need to run the ``taler-merchant-tip-enable'' command -each time after you wire more funds to the reserve. +should wire further funds to the reserve every other week to prevent +it from expiring. @subsection Authorize a tip diff --git a/doc/taler-merchant-tip-enable.1 b/doc/taler-merchant-tip-enable.1 deleted file mode 100644 index b61504b6..00000000 --- a/doc/taler-merchant-tip-enable.1 +++ /dev/null @@ -1,47 +0,0 @@ -.TH TALER\-MERCHANT\-TIP\-ENABLE 1 "Nov 4, 2017" "GNU Taler" - -.SH NAME -taler\-merchant\-tip\-enable \- Tell Taler merchant backend about reserve funding for tipping - -.SH SYNOPSIS -.B taler\-merchant\-tip\-enable -.RI [ options ] -.br - -.SH DESCRIPTION -\fBtaler\-merchant\-tip\-enable\fP is a command line tool to inform the Taler merchant backend that a wire transfer was made to enable tipping from the backend. Note that the command cannot check that the wire transfer was made correctly (with the correct wire subject and the specified amount), and will thus just trust the operator. Enabling tipping at an instance without a wire transfer may cause visitors to receive unfunded tips and experience error messages. You should read the manual chapter on tipping before using this command. - -.SH OPTIONS -.B -.IP "\-a VALUE, \-\-amount=VALUE" -Which amount was transferred into the reserve at the exchange. Must be of the format CUR:VALUE.FRACTION. -.B -.IP "\-b URI, \-\-backend=URI" -At which URI does the backend run that we are to inform about the availability of funding for tipping? -.B -.IP "\-C UUID, \-\-credit-uuid=UUID" -What is the UUID of the wire transfer. The backend will automatically detect if the same UUID is used repeatedly, and ignore multiple invocations. Pass a UUID generated by the wire transfer of the bank. -.B -.IP "\-e TIMESTAMP, \-\-expiration=TIMESTAMP" -When does the reserve expire. Determining this value may today require information from the exchange operator. -.B -.IP "\-h, \-\-help" -Print short help on options. -.B -.IP "\-i NAME, \-\-instance=NAME" -Name of the instance where tipping is to be enabled. The instance must have the reserve (private) key and exchange URI already configured. Note that this command-line tool must also have access to the same configuration with the instance's private key in it. -.B -.IP "\-v, \-\-version" -Print version information. -.B - -.SH SIGNALS -.B -.IP SIGTERM -Sending a SIGTERM to the process will cause it to shutdown cleanly. - -.SH BUGS -Report bugs by using Mantis or by sending electronic mail to - -.SH "SEE ALSO" -\fBtaler\-merchant\-httpd\fP(1), \fBtaler.conf\fP(5) -- cgit v1.2.3