core-lightning/doc/lightning-txsend.7
Christian Decker c3254e6639 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-09-02 16:31:36 +02:00

43 lines
927 B
Groff
Generated

.TH "LIGHTNING-TXSEND" "7" "" "" "lightning-txsend"
.SH NAME
lightning-txsend - Command to sign and send transaction from txprepare
.SH SYNOPSIS
\fBtxsend\fR \fItxid\fR
.SH DESCRIPTION
The \fBtxsend\fR RPC command signs and broadcasts a transaction created by
\fBtxprepare\fR\.
.SH RETURN VALUE
On success, an object with attributes \fItx\fR and \fItxid\fR will be returned\.
\fItx\fR represents the fully signed raw bitcoin transaction, and \fItxid\fR is
the same as the \fItxid\fR argument\.
On failure, an error is reported (from bitcoind), and the inputs from
the transaction are unreserved\.
The following error codes may occur:
.IP \[bu]
-1: Catchall nonspecific error\.
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-txprepare\fR(7), \fBlightning-txdiscard\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR