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

45 lines
1.1 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.TH "LIGHTNING-TXDISCARD" "7" "" "" "lightning-txdiscard"
.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-txdiscard - Abandon a transaction from txprepare, release inputs
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SYNOPSIS
wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. This allows you to prepare a tx, then release or discard it later. Shares almost all the code with json_withdraw (which is now technically superfluous). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-06-05 09:00:05 +02:00
\fBtxdiscard\fR \fItxid\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.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\.
wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. This allows you to prepare a tx, then release or discard it later. Shares almost all the code with json_withdraw (which is now technically superfluous). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-06-05 09:00:05 +02:00
The following error codes may occur:
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
.RS
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.IP \[bu]
-1: An unknown \fItxid\fR\.
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
.RE
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.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
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SEE ALSO
\fBlightning-txprepare\fR(7), \fBlightning-txsend\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
doc, wiregen: use SHA256 stamps instead of git versions. This should be more robust in future: we SHA256 all of the deps. For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 03:13:23 +02:00
\" SHA256STAMP:cd4c671bd56e7afbe224cceb4e454da314e4ac08bb15618780e06da6c12310ed
Reference in New Issue Copy Permalink