vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-fundchannel_cancel.7

57 lines
1.5 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-FUNDCHANNEL_CANCEL" "7" "" "" "lightning-fundchannel_cancel"
.SH NAME
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-fundchannel_cancel - Command for completing channel establishment
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SYNOPSIS
doc: add manpages for fundchannel_[start,complete,cancel] Manpages for the manpage-god!!
2019-06-06 00:32:04 +01:00
\fBfundchannel_cancel\fR \fIid\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH DESCRIPTION
doc: update the document of `fundchannel_cancel`
2019-08-29 08:54:19 +01:00
\fBfundchannel_cancel\fR is a lower level RPC command\. It allows channel funder
to cancel a channel before funding broadcast with a connected peer\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
doc: update the document of `fundchannel_cancel`
2019-08-29 08:54:19 +01:00
\fIid\fR is the node id of the remote peer with which to cancel\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
doc: update the document of `fundchannel_cancel`
2019-08-29 08:54:19 +01:00
Note that the funding transaction MUST NOT be broadcast before
\fBfundchannel_cancel\fR\. Broadcasting transaction before \fBfundchannel_cancel\fR
WILL lead to unrecoverable loss of funds\.
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
doc: update the document of `fundchannel_cancel`
2019-08-29 08:54:19 +01:00
If \fBfundchannel_cancel\fR is called after \fBfundchannel_complete\fR, the remote
peer may disconnect when command succeeds\. In this case, user need to connect
to remote peer again before opening channel\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH RETURN VALUE
On success, returns confirmation that the channel establishment has been
canceled\.
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
On error the returned object will contain \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:
.RS
.IP \[bu]
-32602: If the given parameters are wrong\.
.IP \[bu]
-1: Catchall nonspecific error\.
.IP \[bu]
306: Unknown peer id\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
.RE
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH AUTHOR
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SEE ALSO
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcomplete\fR(7)
.SH RESOURCES
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00