core-lightning/doc
Rusty Russell 83e654a106 close: change to a unilateraltimeout argument.
`close` takes two optional arguments: `force` and `timeout`.
`timeout` doesn't timeout the close (there's no way to do that), just
the JSON call.  `force` (default `false`) if set, means we unilaterally
close at the timeout, instead of just failing.

Timing out JSON calls is generally deprecated: that's the job of the
client.  And the semantics of this are confusing, even to me!  A
better API is a timeout which, if non-zero, is the time at which we
give up and unilaterally close.

The transition code is awkward, but we'll manage for the three
releases until we can remove it.

The new defaults are to unilaterally close after 48 hours.

Fixes: #2791
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-08-09 05:47:16 +00:00
..
release-notes doc: Fixed typo in the release notes 2018-06-18 12:45:00 +02:00
.gitignore Add documentation. 2015-07-18 10:46:53 +09:30
bitcoin.bib bitcoin.bib: Add Satoshi paper URL and date 2018-03-04 03:22:32 +01:00
CHANGELOG.md docs: Add configuration for the sphinx documentation generator 2019-02-18 02:42:29 +00:00
commit-tx.eps Add documentation. 2015-07-18 10:46:53 +09:30
commit-tx.svg Add documentation. 2015-07-18 10:46:53 +09:30
conf.py docs: Autodetect version and copyright year in the sphinx doc 2019-02-22 17:55:36 +01:00
deployable-lightning.lyx udpate broken link 2018-06-08 17:56:48 +02:00
deployable-lightning.pdf Regenerate PDF. 2015-11-20 06:45:19 +10:30
dual-anchor-diag1.eps Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag1.svg Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag2.eps Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag2.svg Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag3.eps Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag3.svg Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor-diag4.eps doc: fix flaw in escape transactions. 2015-07-20 14:07:25 +09:30
dual-anchor-diag4.svg doc: fix flaw in escape transactions. 2015-07-20 14:07:25 +09:30
dual-anchor-final.eps doc: fix flaw in escape transactions. 2015-07-20 14:07:25 +09:30
dual-anchor-final.svg doc: fix flaw in escape transactions. 2015-07-20 14:07:25 +09:30
dual-anchor-take2.svg Add documentation. 2015-07-18 10:46:53 +09:30
dual-anchor.svg Add documentation. 2015-07-18 10:46:53 +09:30
HACKING.md bolt-gen: rm unused bolt-generator; rename new bolt generator 2019-07-24 06:31:46 +00:00
htlc.eps Add documentation. 2015-07-18 10:46:53 +09:30
htlc.svg Add documentation. 2015-07-18 10:46:53 +09:30
index.rst docs: Add configuration for the sphinx documentation generator 2019-02-18 02:42:29 +00:00
INSTALL.md Correct version regex in Makefile, add git as dependency 2019-08-09 02:49:45 +00:00
lightning-autocleaninvoice.7 lightning-autocleaninvoice.7: Properly generate instead of using an empty file. 2018-04-18 12:37:15 +02:00
lightning-autocleaninvoice.7.txt invoices: Implement autocleaninvoice. 2018-03-20 17:25:51 +01:00
lightning-check.7 doc: check manpage 2018-12-10 09:27:49 +01:00
lightning-check.7.txt doc: check manpage 2018-12-10 09:27:49 +01:00
lightning-cli.1 lightning-cli: do pretty-printing. 2019-04-09 12:37:16 -07:00
lightning-cli.1.txt lightning-cli: do pretty-printing. 2019-04-09 12:37:16 -07:00
lightning-close.7 close: change to a unilateraltimeout argument. 2019-08-09 05:47:16 +00:00
lightning-close.7.txt close: change to a unilateraltimeout argument. 2019-08-09 05:47:16 +00:00
lightning-connect.7 doc: fix typo in default port number. 2019-07-30 05:05:45 +00:00
lightning-connect.7.txt doc: fix typo in default port number. 2019-07-30 05:05:45 +00:00
lightning-decodepay.7 CHANGELOG, documentation: update changelog to reflect suffix changes. 2019-02-21 03:44:44 +00:00
lightning-decodepay.7.txt CHANGELOG, documentation: update changelog to reflect suffix changes. 2019-02-21 03:44:44 +00:00
lightning-delexpiredinvoice.7 documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-delexpiredinvoice.7.txt documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-delinvoice.7 documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-delinvoice.7.txt documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-disconnect.7 Update disconnect manpage 2019-04-04 15:13:47 +02:00
lightning-disconnect.7.txt Update disconnect manpage 2019-04-04 15:13:47 +02:00
lightning-fundchannel.7 fundchannel: Update the manpage and Pylightning's method 2019-06-11 23:24:07 +00:00
lightning-fundchannel.7.txt fundchannel: Update the manpage and Pylightning's method 2019-06-11 23:24:07 +00:00
lightning-fundchannel_cancel.7 doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-fundchannel_cancel.7.txt doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-fundchannel_complete.7 doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-fundchannel_complete.7.txt doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-fundchannel_start.7 doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-fundchannel_start.7.txt doc: add manpages for fundchannel_[start,complete,cancel] 2019-06-12 02:22:43 +00:00
lightning-getroute.7 doc: fill in parameters in getroute manpage. 2019-03-01 06:20:58 +00:00
lightning-getroute.7.txt doc: fill in parameters in getroute manpage. 2019-03-01 06:20:58 +00:00
lightning-invoice.7 doc: invoice manpage: add some details about route hint selection 2019-07-31 23:25:37 +00:00
lightning-invoice.7.txt doc: invoice manpage: add some details about route hint selection 2019-07-31 23:25:37 +00:00
lightning-listchannels.7 listchannels: add htlc_minimum_msat and htlc_maximum_msat fields. 2019-06-11 23:19:11 +00:00
lightning-listchannels.7.txt listchannels: add htlc_minimum_msat and htlc_maximum_msat fields. 2019-06-11 23:19:11 +00:00
lightning-listforwards.7 Add missing return fields to the manpage of listforwards 2019-07-18 04:50:00 +00:00
lightning-listforwards.7.txt Add missing return fields to the manpage of listforwards 2019-07-18 04:50:00 +00:00
lightning-listfunds.7 Return output idx for a funding tx in a channel information in listfunds 2019-07-26 06:25:13 +08:00
lightning-listfunds.7.txt Return output idx for a funding tx in a channel information in listfunds 2019-07-26 06:25:13 +08:00
lightning-listinvoices.7 CHANGELOG, documentation: update changelog to reflect suffix changes. 2019-02-21 03:44:44 +00:00
lightning-listinvoices.7.txt CHANGELOG, documentation: update changelog to reflect suffix changes. 2019-02-21 03:44:44 +00:00
lightning-listpays.7 listpays: new command to summarize pay commands. 2019-02-23 05:45:25 +00:00
lightning-listpays.7.txt listsendpays: updated version of listpayments. 2019-02-23 05:45:25 +00:00
lightning-listpeers.7 [docs] Add missing 'level' description for listpeers manpage. 2019-01-08 15:35:17 -08:00
lightning-listpeers.7.txt [docs] Add missing 'level' description for listpeers manpage. 2019-01-08 15:35:17 -08:00
lightning-listsendpays.7 listsendpays: updated version of listpayments. 2019-02-23 05:45:25 +00:00
lightning-listsendpays.7.txt listsendpays: updated version of listpayments. 2019-02-23 05:45:25 +00:00
lightning-newaddr.7 newaddr: support getting both bech32 and p2sh addresses. 2019-03-04 15:11:20 +01:00
lightning-newaddr.7.txt newaddr: support getting both bech32 and p2sh addresses. 2019-03-04 15:11:20 +01:00
lightning-pay.7 doc: Correct preimage field name in pay return value 2019-06-15 10:49:29 +02:00
lightning-pay.7.txt doc: Correct preimage field name in pay return value 2019-06-15 10:49:29 +02:00
lightning-plugin.7 Add a manpage for the 'plugin' command 2019-07-28 07:24:04 +00:00
lightning-plugin.7.txt Add a manpage for the 'plugin' command 2019-07-28 07:24:04 +00:00
lightning-sendpay.7 listsendpays: updated version of listpayments. 2019-02-23 05:45:25 +00:00
lightning-sendpay.7.txt listsendpays: updated version of listpayments. 2019-02-23 05:45:25 +00:00
lightning-setchannelfee.7 doc: setchannelfee 'all' feature 2019-03-19 00:14:09 +00:00
lightning-setchannelfee.7.txt doc: setchannelfee 'all' feature 2019-03-19 00:14:09 +00:00
lightning-txdiscard.7 wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-txdiscard.7.txt wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-txprepare.7 wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-txprepare.7.txt wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-txsend.7 wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-txsend.7.txt wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-waitanyinvoice.7 documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-waitanyinvoice.7.txt documentation: s/Protocol/Command/ 2018-04-27 14:00:16 +02:00
lightning-waitinvoice.7 doc: Regenerate man-pages after spelling corrections 2018-09-07 22:46:56 +02:00
lightning-waitinvoice.7.txt doc: Spelling corrections 2018-09-07 22:46:56 +02:00
lightning-waitsendpay.7 Doc: update 'waitsendpay' manpage 2019-05-19 20:03:05 +02:00
lightning-waitsendpay.7.txt Doc: update 'waitsendpay' manpage 2019-05-19 20:03:05 +02:00
lightning-withdraw.7 wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightning-withdraw.7.txt wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. 2019-06-06 04:47:44 +00:00
lightningd-config.5 doc: Document max-concurrent-htlcs option. 2019-08-09 05:45:06 +00:00
lightningd-config.5.txt doc: Document max-concurrent-htlcs option. 2019-08-09 05:45:06 +00:00
lightningd.8 doc/lightningd.8.txt: Initial manpage for lightningd itself. 2019-08-09 02:36:59 +00:00
lightningd.8.txt doc/lightningd.8.txt: Initial manpage for lightningd itself. 2019-08-09 02:36:59 +00:00
ln-draft-fig1.eps doc: add figures from LN draft (thanks Joseph!). 2015-07-20 14:07:40 +09:30
ln-draft-fig2.eps doc: add figures from LN draft (thanks Joseph!). 2015-07-20 14:07:40 +09:30
Makefile doc/lightningd.8.txt: Initial manpage for lightningd itself. 2019-08-09 02:36:59 +00:00
MAKING-RELEASES.md devtools/credit: script to highlight contributions for this commit. 2019-06-07 13:37:58 +02:00
PLUGINS.md fixup! doc: fix up documentation about when we move into lightning-dir. 2019-08-08 18:17:12 +08:00
REPRODUCIBLE.md doc/REPRODUCIBLE.md: describe to do reproducible builds. 2019-03-01 03:48:04 +00:00
requirements.txt docs: Add configuration for the sphinx documentation generator 2019-02-18 02:42:29 +00:00
STYLE.md Fix typos 2018-03-25 15:53:01 +02:00
TOR.md Fix typos and options 2019-07-15 01:00:57 +00:00