mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
d6a5b87395
core-lightning/doc/lightning-fundchannel_complete.7

54 lines
1.4 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.TH "LIGHTNING-FUNDCHANNEL_COMPLETE" "7" "" "" "lightning-fundchannel_complete"
.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 14:30:56 +02:00
lightning-fundchannel_complete - Command for completing channel establishment
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SYNOPSIS
doc: add manpages for fundchannel_[start,complete,cancel] Manpages for the manpage-god!!
2019-06-06 01:32:04 +02:00
\fBfundchannel_complete\fR \fIid\fR \fItxid\fR \fItxout\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH DESCRIPTION
\fBfundchannel_complete\fR is a lower level RPC command\. It allows a user to
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
complete an initiated channel establishment with a connected peer\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
\fIid\fR is the node id of the remote peer\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
\fItxid\fR is the hex string of the funding transaction id\.
\fItxout\fR is the integer outpoint of the funding output for this channel\.
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
Note that the funding transaction MUST NOT be broadcast until after
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
successfully completes\. Broadcasting transaction before can lead to
unrecoverable loss of funds\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH RETURN VALUE
On success, returns a confirmation that \fIcommitments_secured\fR and the
derived \fIchannel_id\fR\.
On failure, returns an error\.
.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 14:30:56 +02:00
Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SEE ALSO
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),
lightning-fundchannel_\fBstart\fR(7), lightning-fundchannel_\fBcancel\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 14:30:56 +02:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.HL
Last updated 2019-06-12 11:16:20 CEST
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 14:30:56 +02:00
Reference in New Issue Copy Permalink