mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-18 05:12:45 +01:00
Code Issues Projects Releases Wiki Activity

doc: clarify txprepare usage

Browse Source
This commit is contained in:
darosior 2020-02-17 17:34:29 +01:00 committed by Christian Decker
parent cd15cec2f3
commit 230cebfb35
2 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/lightning-txprepare.7 generated
View File

@ -1,6 +1,6 @@
.TH "LIGHTNING-TXPREPARE" "7" "" "" "lightning-txprepare"
.SH NAME
lightning-txprepare - Command to prepare to withdraw funds from the internal wallet
.SH SYNOPSIS
\fBtxprepare\fR \fIoutputs\fR [\fIfeerate\fR] [\fIminconf\fR] [\fIutxos\fR]
@ -17,7 +17,7 @@ and \fIamount\fR({\fIdestination\fR: \fIamount\fR})\. Its format is like:
[{address1: amount1}, {address2: amount2}]
or
[{address: \fIall\fR}]\.
It supports the any number of outputs\.
It supports any number of \fBconfirmed\fR outputs\.
The \fIdestination\fR of output is the address which can be of any Bitcoin accepted
@ -55,7 +55,6 @@ of "txid:vout"\. These must be drawn from the node's available UTXO set\.
supports multiple outputs and uses \fIoutputs\fR as parameter\. The second part
is provided by \fBtxsend\fR\.
.SH RETURN VALUE
On success, an object with attributes \fIunsigned_tx\fR and \fItxid\fR will be
@ -85,7 +84,7 @@ fees) to create the transaction\.
.RE
.SH AUTHOR
Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly responsible\.
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
@ -93,5 +92,5 @@ Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly responsible\.
.SH RESOURCES
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

2
doc/lightning-txprepare.7.md
View File

@ -18,7 +18,7 @@ and *amount*(\{*destination*: *amount*\}). Its format is like:
\[\{address1: amount1\}, \{address2: amount2\}\]
or
\[\{address: *all*\}\].
It supports the any number of outputs.
It supports any number of **confirmed** outputs.
The *destination* of output is the address which can be of any Bitcoin accepted
type, including bech32.