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.
1.5 KiB
lightning-fundchannel_start -- Command for initiating channel establishment for a lightning channel
SYNOPSIS
fundchannel_start id satoshi [feerate announce]
DESCRIPTION
fundchannel_start
is a lower level RPC command. It allows a user to
initiate channel establishment with a connected peer.
id is the node id of the remote peer.
satoshi 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.
feerate is an optional field. Sets the feerate for subsequent commitment transactions.
announce whether or not to announce this channel.
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed by running
fundchannel_complete
, as the commitment transactions for this channel
are not secured until the complete command succeeds. Broadcasting
transaction before that can lead to unrecoverable loss of funds.
RETURN VALUE
On success, returns the funding_address for the channel.
On failure, returns an error.
AUTHOR
Lisa Neigut <niftynei@gmail.com> is mainly responsible.
SEE ALSO
lightning-connect(7), lightning-fundchannel(7), lightning-fundchannel_complete(7), lightning-fundchannel_cancel(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning