Skip to content

Commit

Permalink
doc: add lightning-waitinvoice man page.
Browse files Browse the repository at this point in the history
Signed-off-by: Rusty Russell <[email protected]>
  • Loading branch information
rustyrussell committed Jan 23, 2017
1 parent 69079e5 commit 2fb2e75
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-waitanyinvoice.7
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ On success, the \fIrhash\fR, \fIlabel\fR, and \fImsatoshi\fR will be returned\&.
Rusty Russell <rusty@rustcorp\&.com\&.au> 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
2 changes: 1 addition & 1 deletion doc/lightning-waitanyinvoice.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Rusty Russell <[email protected]> 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
---------
Expand Down
49 changes: 49 additions & 0 deletions doc/lightning-waitinvoice.7
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
'\" t
.\" Title: lightning-waitinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" 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 <decker\&.christian@gmail\&.com> 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
34 changes: 34 additions & 0 deletions doc/lightning-waitinvoice.7.txt
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> 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

0 comments on commit 2fb2e75

Please sign in to comment.