core-lightning/doc/lightning-txdiscard.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

46 lines
1.1 KiB
Groff
Generated

.TH "LIGHTNING-TXDISCARD" "7" "" "" "lightning-txdiscard"
.SH NAME
lightning-txdiscard - Abandon a transaction from txprepare, release inputs
.SH SYNOPSIS
\fBtxdiscard\fR \fItxid\fR
.SH DESCRIPTION
The \fBtxdiscard\fR RPC command releases inputs which were reserved for
use of the \fItxid\fR from \fBlightning-txprepare\fR(7)\.
.SH RETURN VALUE
On success, an object with attributes \fIunsigned_tx\fR and \fItxid\fR will be
returned, exactly as from \fBlightning-txprepare\fR(7)\.
If there is no matching \fItxid\fR, an error is reported\. Note that this may
happen due to incorrect usage (such as \fBtxdiscard\fR or \fBtxsend\fR
already being called for \fItxid\fR) or due to lightningd restarting, which
implicitly calls \fBtxdiscard\fR on all outputs\.
The following error codes may occur:
.IP \[bu]
-1: An unknown \fItxid\fR\.
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-txprepare\fR(7), \fBlightning-txsend\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
.HL
Last updated 2019-06-08 16:03:59 CEST