Skip to content

Commit 1da8e49

Browse files
committed
doc: fill in parameters in getroute manpage.
Fixes: #2419 Signed-off-by: Rusty Russell <[email protected]>
1 parent a988ed7 commit 1da8e49

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

doc/lightning-getroute.7

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: lightning-getroute
33
.\" Author: [see the "AUTHOR" section]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 02/23/2019
5+
.\" Date: 03/01/2019
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "LIGHTNING\-GETROUTE" "7" "02/23/2019" "\ \&" "\ \&"
10+
.TH "LIGHTNING\-GETROUTE" "7" "03/01/2019" "\ \&" "\ \&"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -31,7 +31,7 @@
3131
lightning-getroute \- Command for routing a payment (low\-level)\&.
3232
.SH "SYNOPSIS"
3333
.sp
34-
\fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR] [\fIfromid\fR] [\fIfuzzpercent\fR]
34+
\fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR] [\fIfromid\fR] [\fIfuzzpercent\fR] [\fIexclude\fR] [\fImaxhops\fR]
3535
.SH "DESCRIPTION"
3636
.sp
3737
The \fBgetroute\fR RPC command attempts to find the best route for the payment of \fImsatoshi\fR to lightning node \fIid\fR, such that the payment will arrive at \fIid\fR with \fIcltv\fR\-blocks to spare (default 9)\&.
@@ -47,6 +47,10 @@ If you didn\(cqt care about risk, \fIriskfactor\fR would be zero\&.
4747
\fIfromid\fR is the node to start the route from: default is this node\&.
4848
.sp
4949
The \fIfuzzpercent\fR is a positive floating\-point number, representing a percentage of the actual fee\&. The \fIfuzzpercent\fR is used to distort computed fees along each channel, to provide some randomization to the route generated\&. 0\&.0 means the exact fee of that channel is used, while 100\&.0 means the fee used might be from 0 to twice the actual fee\&. The default is 5\&.0, or up to 5% fee distortion\&.
50+
.sp
51+
\fIexclude\fR is a JSON array of short\-channel\-id/direction (e\&.g\&. [ "564334x877x1/0", "564195x1292x0/1" ]) which should be excluded from consideration for routing\&. The default is not to exclude any channels\&.
52+
.sp
53+
\fImaxhops\fR is the maximum number of channels to return; default is 20\&.
5054
.SH "RISKFACTOR EFFECT ON ROUTING"
5155
.sp
5256
The risk factor is treated as if it were an additional fee on the route, for the purposes of comparing routes\&.

doc/lightning-getroute.7.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ lightning-getroute - Command for routing a payment (low-level).
99

1010
SYNOPSIS
1111
--------
12-
*getroute* 'id' 'msatoshi' 'riskfactor' ['cltv'] ['fromid'] ['fuzzpercent']
12+
*getroute* 'id' 'msatoshi' 'riskfactor' ['cltv'] ['fromid'] ['fuzzpercent'] ['exclude'] ['maxhops']
1313

1414
DESCRIPTION
1515
-----------
@@ -42,6 +42,9 @@ to provide some randomization to the route generated.
4242
while 100.0 means the fee used might be from 0 to twice the actual fee.
4343
The default is 5.0, or up to 5% fee distortion.
4444

45+
'exclude' is a JSON array of short-channel-id/direction (e.g. [ "564334x877x1/0", "564195x1292x0/1" ]) which should be excluded from consideration for routing. The default is not to exclude any channels.
46+
47+
'maxhops' is the maximum number of channels to return; default is 20.
4548

4649
RISKFACTOR EFFECT ON ROUTING
4750
----------------------------

0 commit comments

Comments
 (0)