aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-02-19 21:14:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix getroute manpage rendering

Browse Source 
My manpage viewer did not know what to do with curly braces,
so I switched them to quotes and it works fine.

Signed-off-by: Mark Beckwith <wythe@intrig.com>
This commit is contained in:
Mark Beckwith
2019-01-23 10:39:56 -06:00
committed by neil saitug
parent 17b969383b
commit 287af7b660
2 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lightning-getroute.7
View File

@@ -2,12 +2,12 @@
.\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 12/17/2018
.\" Date: 01/23/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-GETROUTE" "7" "12/17/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-GETROUTE" "7" "01/23/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -257,9 +257,9 @@ T}
1000 is an aggressive value for trying to minimize timeouts at all costs\&.
.SH "RETURN VALUE"
.sp
On success, a "route" array is returned\&. Each array element contains
On success, a "route" array is returned\&. Each array element contains \fIid\fR (the node being routed through), \fImsatoshi\fR (the millisatoshis sent), and \fIdelay\fR (the number of blocks to timeout at this node)\&.
.sp
timeout for the payment failure, in blocks\&.
The final \fIid\fR will be the destination \fIid\fR given in the input\&. The difference between the first \fImsatoshi\fR minus the \fImsatoshi\fR given in the input is the fee\&. The first \fIdelay\fR is the very worst case timeout for the payment failure, in blocks\&.
.SH "AUTHOR"
.sp
Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&.

13
doc/lightning-getroute.7.txt
View File

@@ -95,13 +95,14 @@ costs.
RETURN VALUE
------------
On success, a "route" array is returned. Each array element contains
{id} (the node being routed through), {msatoshi} (the millisatoshis
sent), and {delay} (the number of blocks to timeout at this node).
On success, a "route" array is returned.
Each array element contains 'id' (the node being routed through), 'msatoshi'
(the millisatoshis sent), and 'delay' (the number of blocks to timeout at this
node).
The final {id} will be the destination {id} given in the input. The
difference between the first {msatoshi} minus the {msatoshi} given in
the input is the fee. The first {delay} is the very worst case
The final 'id' will be the destination 'id' given in the input. The
difference between the first 'msatoshi' minus the 'msatoshi' given in
the input is the fee. The first 'delay' is the very worst case
timeout for the payment failure, in blocks.
//FIXME:Enumerate errors