doc: add exclude arg doc for pay rpc

This commit is contained in:
Andrew Toth
2021-11-18 14:24:49 -05:00
committed by Rusty Russell
parent 69bc1191cb
commit 5483465fb5

View File

@@ -6,6 +6,7 @@ SYNOPSIS
**pay** *bolt11* \[*msatoshi*\] \[*label*\] \[*riskfactor*\]
\[*maxfeepercent*\] \[*retry\_for*\] \[*maxdelay*\] \[*exemptfee*\]
\[*exclude*\]
DESCRIPTION
-----------
@@ -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.