core-lightning/doc/lightning-txdiscard.7
Rusty Russell 6d1897b796 doc: fix GH/readthedocs rendering of manual pages.
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-05 15:02:17 +02:00

49 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 is returned, containing:
.RS
.IP \[bu]
\fBunsigned_tx\fR (hex): the unsigned transaction
.IP \[bu]
\fBtxid\fR (txid): the transaction id of \fIunsigned_tx\fR
.RE
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\.
The following error codes may occur:
.RS
.IP \[bu]
-1: An unknown \fItxid\fR\.
.RE
.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
\" SHA256STAMP:7257c3119d49b4252aad8e03949c41a777ba5e94eb82db7c4a3ce576a157dc59