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
697b501132
core-lightning/doc/lightning-fundchannel_start.7

59 lines
1.6 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.TH "LIGHTNING-FUNDCHANNEL_START" "7" "" "" "lightning-fundchannel_start"
.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_start - Command for initiating channel establishment for a lightning channel
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_start\fR \fIid\fR \fIsatoshi\fR [\fIfeerate\fR \fIannounce\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH DESCRIPTION
\fBfundchannel_start\fR is a lower level RPC command\. It allows a user to
initiate channel establishment with a connected peer\.
\fIid\fR is the node id of the remote peer\.
\fIsatoshi\fR is the satoshi value that the channel will be funded at\. This
value MUST be accurate, otherwise the negotiated commitment transactions
will not encompass the correct channel value\.
\fIfeerate\fR is an optional field\. Sets the feerate for subsequent
commitment transactions\.
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
\fIannounce\fR whether or not to announce this channel\.
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
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
channel establishment has been successfully completed by running
\fBfundchannel_complete\fR, as the commitment transactions for this channel
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
are not secured until the complete command succeeds\. Broadcasting
doc: fix wording for fundchannel_complete
2019-08-21 10:55:49 +02:00
transaction before that 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
rpc: have fundchannel_start also return scriptpubkey Easier to pass it back than dig it out of the address, since we have it. Needed for extracting fundchannel
2019-08-28 05:33:55 +02:00
On success, returns the \fIfunding_address\fR and the \fIscriptpubkey\fR for the channel funding output\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
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_\fBcomplete\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