From 182556cfdab49a7fb33b836a9aad376d59c4df67 Mon Sep 17 00:00:00 2001 From: darosior Date: Thu, 9 May 2019 15:29:32 +0200 Subject: [PATCH] Updated 'listfunds' doc and manpage --- doc/lightning-listfunds.7 | 34 +++++++++++++++++----------------- doc/lightning-listfunds.7.txt | 14 +++++++------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/doc/lightning-listfunds.7 b/doc/lightning-listfunds.7 index d9a84475c..52f0442f3 100644 --- a/doc/lightning-listfunds.7 +++ b/doc/lightning-listfunds.7 @@ -2,12 +2,12 @@ .\" Title: lightning-listfunds .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 02/18/2019 +.\" Date: 05/09/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-LISTFUNDS" "7" "02/18/2019" "\ \&" "\ \&" +.TH "LIGHTNING\-LISTFUNDS" "7" "05/09/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -60,7 +60,7 @@ Each entry in \fIoutputs\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIaddress\fR +\fIoutput\fR (the index of the output in the transaction) .RE .sp .RS 4 @@ -71,7 +71,7 @@ Each entry in \fIoutputs\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIoutput\fR +\fIvalue\fR (the output value in satoshis) .RE .sp .RS 4 @@ -82,7 +82,12 @@ Each entry in \fIoutputs\fR will include: .sp -1 .IP \(bu 2.3 .\} +\fIamount_sat\fR +(the same as \fIvalue\fR +, but in millisatoshis with +\fImsat\fR +appended) .RE .sp .RS 4 @@ -93,12 +98,7 @@ Each entry in \fIoutputs\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIamount_sat\fR -(the same as -\fIvalue\fR -with -\fIsat\fR -appended) +\fIaddress\fR .RE .sp .RS 4 @@ -109,7 +109,7 @@ appended) .sp -1 .IP \(bu 2.3 .\} -\fIstatus\fR +\fIstatus\fR (whether \fIunconfirmed\fR, \fIconfirmed\fR, or \fIspent\fR) .RE .sp Each entry in \fIchannels\fR will include: @@ -158,9 +158,9 @@ Each entry in \fIchannels\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIour_amount_sat\fR -\- same as above, but with -\fIsat\fR +\fIour_amount_msat\fR +\- same as above, but in millisatoshis with +\fImsat\fR appended\&. .RE .sp @@ -184,9 +184,9 @@ appended\&. .sp -1 .IP \(bu 2.3 .\} -\fIamount_sat\fR -\- same as above, but with -\fIsat\fR +\fIamount_msat\fR +\- same as above, but in millisatoshis with +\fImsat\fR appended\&. .RE .sp diff --git a/doc/lightning-listfunds.7.txt b/doc/lightning-listfunds.7.txt index 22265f6ba..b9b19f4f6 100644 --- a/doc/lightning-listfunds.7.txt +++ b/doc/lightning-listfunds.7.txt @@ -27,15 +27,15 @@ Each entry in 'outputs' will include: - '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: @@ -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 (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 -- '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.