Browse Source

Updated 'listfunds' doc and manpage

htlc_accepted_hook
darosior 6 years ago
committed by Rusty Russell
parent
commit
182556cfda
  1. 34
      doc/lightning-listfunds.7
  2. 14
      doc/lightning-listfunds.7.txt

34
doc/lightning-listfunds.7

@ -2,12 +2,12 @@
.\" Title: lightning-listfunds .\" Title: lightning-listfunds
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/18/2019 .\" Date: 05/09/2019
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-LISTFUNDS" "7" "02/18/2019" "\ \&" "\ \&" .TH "LIGHTNING\-LISTFUNDS" "7" "05/09/2019" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -60,7 +60,7 @@ Each entry in \fIoutputs\fR will include:
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIaddress\fR \fIoutput\fR (the index of the output in the transaction)
.RE .RE
.sp .sp
.RS 4 .RS 4
@ -71,7 +71,7 @@ Each entry in \fIoutputs\fR will include:
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIoutput\fR \fIvalue\fR (the output value in satoshis)
.RE .RE
.sp .sp
.RS 4 .RS 4
@ -82,7 +82,12 @@ Each entry in \fIoutputs\fR will include:
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIamount_sat\fR
(the same as
\fIvalue\fR \fIvalue\fR
, but in millisatoshis with
\fImsat\fR
appended)
.RE .RE
.sp .sp
.RS 4 .RS 4
@ -93,12 +98,7 @@ Each entry in \fIoutputs\fR will include:
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIamount_sat\fR \fIaddress\fR
(the same as
\fIvalue\fR
with
\fIsat\fR
appended)
.RE .RE
.sp .sp
.RS 4 .RS 4
@ -109,7 +109,7 @@ appended)
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIstatus\fR \fIstatus\fR (whether \fIunconfirmed\fR, \fIconfirmed\fR, or \fIspent\fR)
.RE .RE
.sp .sp
Each entry in \fIchannels\fR will include: Each entry in \fIchannels\fR will include:
@ -158,9 +158,9 @@ Each entry in \fIchannels\fR will include:
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIour_amount_sat\fR \fIour_amount_msat\fR
\- same as above, but with \- same as above, but in millisatoshis with
\fIsat\fR \fImsat\fR
appended\&. appended\&.
.RE .RE
.sp .sp
@ -184,9 +184,9 @@ appended\&.
.sp -1 .sp -1
.IP \(bu 2.3 .IP \(bu 2.3
.\} .\}
\fIamount_sat\fR \fIamount_msat\fR
\- same as above, but with \- same as above, but in millisatoshis with
\fIsat\fR \fImsat\fR
appended\&. appended\&.
.RE .RE
.sp .sp

14
doc/lightning-listfunds.7.txt

@ -27,15 +27,15 @@ Each entry in 'outputs' will include:
- 'txid' - 'txid'
- 'address' - 'output' (the index of the output in the transaction)
- 'output' - 'value' (the output value in satoshis)
- 'value' - 'amount_msat' (the same as 'value', but in millisatoshi with 'msat' appended)
- 'amount_sat' (the same as 'value' with 'sat' appended) - 'address'
- 'status' - 'status' (whether 'unconfirmed', 'confirmed', or 'spent')
Each entry in 'channels' will include: Each entry in 'channels' will include:
@ -47,11 +47,11 @@ number and output index of the channel funding transaction).
- 'channel_sat' - available satoshis on our node's end of the channel - 'channel_sat' - available satoshis on our node's end of the channel
(values rounded down to satoshis as internal storage is in millisatoshi). (values rounded down to satoshis as internal storage is in millisatoshi).
- 'our_amount_sat' - same as above, but with 'sat' appended. - 'our_amount_msat' - same as above, but in millisatoshis with 'msat' appended.
- 'channel_total_sat' - total channel value in satoshi - 'channel_total_sat' - total channel value in satoshi
- 'amount_sat' - same as above, but with 'sat' appended. - 'amount_msat' - same as above, but in millisatoshis with 'msat' appended.
- 'funding_txid' - funding transaction id. - 'funding_txid' - funding transaction id.

Loading…
Cancel
Save