diff --git a/doc/Makefile b/doc/Makefile index da873add2..7e5efb7fc 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -10,6 +10,7 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightning-invoice.7 \ doc/lightning-listinvoice.7 \ doc/lightning-sendpay.7 \ + doc/lightning-waitinvoice.7 \ doc/lightning-waitanyinvoice.7 doc-all: $(MANPAGES) diff --git a/doc/lightning-waitanyinvoice.7 b/doc/lightning-waitanyinvoice.7 index b8175a176..411a7c9db 100644 --- a/doc/lightning-waitanyinvoice.7 +++ b/doc/lightning-waitanyinvoice.7 @@ -45,7 +45,7 @@ On success, the \fIrhash\fR, \fIlabel\fR, and \fImsatoshi\fR will be returned\&. Rusty Russell is mainly responsible\&. .SH "SEE ALSO" .sp -lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7)\&. +lighting\-waitinvoice(7), lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7)\&. .SH "RESOURCES" .sp Main web site: https://github\&.com/ElementsProject/lightning diff --git a/doc/lightning-waitanyinvoice.7.txt b/doc/lightning-waitanyinvoice.7.txt index 7819835b3..cb33443a0 100644 --- a/doc/lightning-waitanyinvoice.7.txt +++ b/doc/lightning-waitanyinvoice.7.txt @@ -32,7 +32,7 @@ Rusty Russell is mainly responsible. SEE ALSO -------- -lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7). +lighting-waitinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7). RESOURCES --------- diff --git a/doc/lightning-waitinvoice.7 b/doc/lightning-waitinvoice.7 new file mode 100644 index 000000000..c751b1562 --- /dev/null +++ b/doc/lightning-waitinvoice.7 @@ -0,0 +1,49 @@ +'\" t +.\" Title: lightning-waitinvoice +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 01/23/2017 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "LIGHTNING\-WAITINVOI" "7" "01/23/2017" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +lightning-waitinvoice \- Protocol for waiting for specific payment\&. +.SH "SYNOPSIS" +.sp +\fBwaitinvoice\fR \fIlabel\fR +.SH "DESCRIPTION" +.sp +The \fBwaitinvoice\fR RPC command waits until a specific invoice is paid, then returns that single entry as per \fBlistinvoice\fR\&. +.SH "RETURN VALUE" +.sp +On success, the \fIrhash\fR, \fIlabel\fR, and \fImsatoshi\fR will be returned\&. +.SH "AUTHOR" +.sp +Christian Decker is mainly responsible\&. +.SH "SEE ALSO" +.sp +lightning\-waitanyinvoice(7), lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7) +.SH "RESOURCES" +.sp +Main web site: https://github\&.com/ElementsProject/lightning diff --git a/doc/lightning-waitinvoice.7.txt b/doc/lightning-waitinvoice.7.txt new file mode 100644 index 000000000..01b851926 --- /dev/null +++ b/doc/lightning-waitinvoice.7.txt @@ -0,0 +1,34 @@ +LIGHTNING-WAITINVOICE(7) +======================== +:doctype: manpage + +NAME +---- +lightning-waitinvoice - Protocol for waiting for specific payment. + +SYNOPSIS +-------- +*waitinvoice* 'label' + +DESCRIPTION +----------- +The *waitinvoice* RPC command waits until a specific invoice is paid, then +returns that single entry as per *listinvoice*. + +RETURN VALUE +------------ +On success, the 'rhash', 'label', and 'msatoshi' will be returned. + +//FIXME:Enumerate errors + +AUTHOR +------ +Christian Decker is mainly responsible. + +SEE ALSO +-------- +lightning-waitanyinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7) + +RESOURCES +--------- +Main web site: https://github.com/ElementsProject/lightning