aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-01-06 15:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc/manpages: regenerate manpages using markdown templates

Browse Source
This commit is contained in:
darosior
2019-08-10 02:12:44 +02:00
committed by Rusty Russell
parent 76a4c5f287
commit d37a2d7c3e
36 changed files with 3272 additions and 4542 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
doc/lightning-txdiscard.7
View File

@@ -1,65 +1,51 @@
'\" t
.\" Title: lightning-txdiscard
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 06/05/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-TXDISCARD" "7" "06/05/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-txdiscard \- Abandon a transaction from txprepare, release inputs
.SH "SYNOPSIS"
.sp
.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"
.sp
The \fBtxdiscard\fR RPC command releases inputs which were reserved for use of the \fItxid\fR from lightning\-txprepare(7)\&.
.SH "RETURN VALUE"
.sp
On success, an object with attributes \fIunsigned_tx\fR and \fItxid\fR will be returned, exactly as from lightning\-txprepare(7)\&.
.sp
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\&.
.sp
.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:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-1\&. An unknown
\fItxid\fR\&.
.RS
.IP \[bu]
-1: An unknown \fItxid\fR\.
.RE
.SH "AUTHOR"
.sp
Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&.
.SH "SEE ALSO"
.sp
lightning\-txprepare(7), lightning\-txsend(7)
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning
.SH AUTHOR
Rusty Russell \fBNone\fR (\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: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-06-08 16:03:59 CEST