Updated listforwards doc with new parameters

ElementsProject · Jan 29, 2021 · 267b2a0 · 267b2a0
1 parent 7cae0d6
commit 267b2a0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/doc/lightning-listforwards.7 b/doc/lightning-listforwards.7
diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md
@@ -4,14 +4,20 @@ lightning-listforwards -- Command showing all htlcs and their information
 SYNOPSIS
 --------
 
-**listforwards**
+**listforwards** \[*status*\] \[*in_channel*\] \[*out_channel*\]
 
 DESCRIPTION
 -----------
 
 The **listforwards** RPC command displays all htlcs that have been
 attempted to be forwarded by the c-lightning node.
 
+If *status* is specified, then only the forwards with the given status are returned.
+*status* can be either *offered* or *settled* or *failed* or *local_failed*
+
+If *in_channel* or *out_channel* is specified, then only the matching forwards
+on the given in/out channel are returned.
+
 RETURN VALUE
 ------------