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

Add missing return fields to the manpage of listforwards

Browse Source
This commit is contained in:
Kristaps Kaupe 2019-07-15 00:53:08 +03:00 committed by Rusty Russell
parent b3215a866b
commit 868bde5e00
2 changed files with 39 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/lightning-listforwards.7
View File

@ -2,12 +2,12 @@
.\" Title: lightning-listforwards
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 05/23/2019
.\" Date: 07/15/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-LISTFORWA" "7" "05/23/2019" "\ \&" "\ \&"
.TH "LIGHTNING\-LISTFORWA" "7" "07/15/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -73,7 +73,8 @@ Each entry in \fIforwards\fR will include:
.sp -1
.IP \(bu 2.3
.\}
\fIin_msatoshi\fR
\fIin_msatoshi\fR,
\fIin_msat\fR
\- amount of msatoshis that are forwarded to this node\&.
.RE
.sp
@ -85,7 +86,8 @@ Each entry in \fIforwards\fR will include:
.sp -1
.IP \(bu 2.3
.\}
\fIout_msatoshi\fR
\fIout_msatoshi\fR,
\fIout_msat\fR
\- amount of msatoshis to be forwarded\&.
.RE
.sp
@ -97,7 +99,8 @@ Each entry in \fIforwards\fR will include:
.sp -1
.IP \(bu 2.3
.\}
\fIfee\fR
\fIfee\fR,
\fIfee_msat\fR
\- fee offered for forwarding the htlc in msatoshi\&.
.RE
.sp
@ -118,6 +121,30 @@ if the routing process is completed or
\fIfailed\fR
if the routing process could not be completed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIreceived_time\fR
\- timestamp when incoming htlc was received\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIresolved_time\fR
\- timestamp when htlc was resolved (settled or failed)\&.
.RE
.SH "AUTHOR"
.sp
Rene Pickhardt <r\&.pickhardt@gmail\&.com> is mainly responsible\&.

10
doc/lightning-listforwards.7.txt
View File

@ -24,14 +24,18 @@ Each entry in 'forwards' will include:
- 'out_channel' - the short_channel_id of to which the outgoing htlc is supposed to be forwarded.
- 'in_msatoshi' - amount of msatoshis that are forwarded to this node.
- 'in_msatoshi', 'in_msat' - amount of msatoshis that are forwarded to this node.
- 'out_msatoshi' - amount of msatoshis to be forwarded.
- 'out_msatoshi', 'out_msat' - amount of msatoshis to be forwarded.
- 'fee' - fee offered for forwarding the htlc in msatoshi.
- 'fee', 'fee_msat' - fee offered for forwarding the htlc in msatoshi.
- 'status' - status can be either 'offered' if the routing process is still ongoing, 'settled' if the routing process is completed or 'failed' if the routing process could not be completed.
- 'received_time' - timestamp when incoming htlc was received.
- 'resolved_time' - timestamp when htlc was resolved (settled or failed).
AUTHOR
------
Rene Pickhardt <r.pickhardt@gmail.com> is mainly responsible.