mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-18 05:12:45 +01:00
Code Issues Projects Releases Wiki Activity

doc: Update manpage for waitinvoice.

Browse Source
This commit is contained in:
ZmnSCPxj 2018-01-23 13:20:47 +00:00 committed by Rusty Russell
parent 0925e404d6
commit ba24fe0ba3
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lightning-waitinvoice.7
View File

@ -2,12 +2,12 @@
.\" Title: lightning-waitinvoice .\" Title: lightning-waitinvoice
.\" 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: 01/13/2018 .\" Date: 02/03/2018
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-WAITINVOI" "7" "01/13/2018" "\ \&" "\ \&" .TH "LIGHTNING\-WAITINVOI" "7" "02/03/2018" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -37,7 +37,11 @@ lightning-waitinvoice \- Protocol for waiting for specific payment\&.
The \fBwaitinvoice\fR RPC command waits until a specific invoice is paid, then returns that single entry as per \fBlistinvoice\fR\&. The \fBwaitinvoice\fR RPC command waits until a specific invoice is paid, then returns that single entry as per \fBlistinvoice\fR\&.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.sp .sp
On success, an invoice description will be returned as per lightning\-listinvoice(7): \fIcomplete\fR will always be \fItrue\fR\&. On success, an invoice description will be returned as per lightning\-listinvoice(7)\&. The \fIstatus\fR field will be \fIpaid\fR\&.
.sp
If the invoice is deleted while unpaid, or the invoice does not exist, this command will return with an error with code \-1\&.
.sp
If the invoice expires before being pad, or is already expired, this command will return with an error with code \-2, with the data being the invoice data as per \fBlistinvoice\fR\&.
.SH "AUTHOR" .SH "AUTHOR"
.sp .sp
Christian Decker <decker\&.christian@gmail\&.com> is mainly responsible\&. Christian Decker <decker\&.christian@gmail\&.com> is mainly responsible\&.

14
doc/lightning-waitinvoice.7.txt
View File

@ -12,14 +12,20 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
The *waitinvoice* RPC command waits until a specific invoice is paid, then The *waitinvoice* RPC command waits until a specific invoice is paid,
returns that single entry as per *listinvoice*. then returns that single entry as per *listinvoice*.
RETURN VALUE RETURN VALUE
------------ ------------
On success, an invoice description will be returned as per lightning-listinvoice(7): 'complete' will always be 'true'. On success, an invoice description will be returned as per lightning-listinvoice(7).
The 'status' field will be 'paid'.
//FIXME:Enumerate errors If the invoice is deleted while unpaid, or the invoice does not exist,
this command will return with an error with code -1.
If the invoice expires before being pad, or is already expired, this
command will return with an error with code -2, with the data being
the invoice data as per *listinvoice*.
AUTHOR AUTHOR
------ ------