Browse Source

docs: fix getroute manpage rendering

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>
sanitizers
Mark Beckwith 6 years ago
committed by neil saitug
parent
commit
287af7b660
  1. 8
      doc/lightning-getroute.7
  2. 15
      doc/lightning-getroute.7.txt

8
doc/lightning-getroute.7

@ -2,12 +2,12 @@
.\" Title: lightning-getroute .\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 12/17/2018 .\" Date: 01/23/2019
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-GETROUTE" "7" "12/17/2018" "\ \&" "\ \&" .TH "LIGHTNING\-GETROUTE" "7" "01/23/2019" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -257,9 +257,9 @@ T}
1000 is an aggressive value for trying to minimize timeouts at all costs\&. 1000 is an aggressive value for trying to minimize timeouts at all costs\&.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.sp .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 .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" .SH "AUTHOR"
.sp .sp
Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&. Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&.

15
doc/lightning-getroute.7.txt

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

Loading…
Cancel
Save