Skip to content

Commit

Permalink
doc: add exclude arg doc for pay rpc
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtoth authored and rustyrussell committed Dec 4, 2021
1 parent 69bc119 commit 5483465
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/lightning-pay.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ SYNOPSIS

**pay** *bolt11* \[*msatoshi*\] \[*label*\] \[*riskfactor*\]
\[*maxfeepercent*\] \[*retry\_for*\] \[*maxdelay*\] \[*exemptfee*\]
\[*exclude*\]

DESCRIPTION
-----------
Expand Down Expand Up @@ -40,6 +41,11 @@ finding routes and retrying the payment. However, a payment may be
delayed for up to `maxdelay` blocks by another node; clients should be
prepared for this worst case.

*exclude* is a JSON array of short-channel-id/direction (e.g. \[
"564334x877x1/0", "564195x1292x0/1" \]) or node-id which should be excluded
from consideration for routing. The default is not to exclude any channels
or nodes.

When using *lightning-cli*, you may skip optional parameters by using
*null*. Alternatively, use **-k** option to provide parameters by name.

Expand Down

0 comments on commit 5483465

Please sign in to comment.