Skip to content

Commit 2fb2e75

Browse files
committedJan 23, 2017
doc: add lightning-waitinvoice man page.
Signed-off-by: Rusty Russell <[email protected]>
1 parent 69079e5 commit 2fb2e75

5 files changed

+86
-2
lines changed
 

‎doc/Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ MANPAGES := doc/lightning-cli.1 \
1010
doc/lightning-invoice.7 \
1111
doc/lightning-listinvoice.7 \
1212
doc/lightning-sendpay.7 \
13+
doc/lightning-waitinvoice.7 \
1314
doc/lightning-waitanyinvoice.7
1415

1516
doc-all: $(MANPAGES)

‎doc/lightning-waitanyinvoice.7

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ On success, the \fIrhash\fR, \fIlabel\fR, and \fImsatoshi\fR will be returned\&.
4545
Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&.
4646
.SH "SEE ALSO"
4747
.sp
48-
lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7)\&.
48+
lighting\-waitinvoice(7), lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7)\&.
4949
.SH "RESOURCES"
5050
.sp
5151
Main web site: https://github\&.com/ElementsProject/lightning

‎doc/lightning-waitanyinvoice.7.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
3232

3333
SEE ALSO
3434
--------
35-
lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
35+
lighting-waitinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
3636

3737
RESOURCES
3838
---------

‎doc/lightning-waitinvoice.7

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
'\" t
2+
.\" Title: lightning-waitinvoice
3+
.\" Author: [see the "AUTHOR" section]
4+
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5+
.\" Date: 01/23/2017
6+
.\" Manual: \ \&
7+
.\" Source: \ \&
8+
.\" Language: English
9+
.\"
10+
.TH "LIGHTNING\-WAITINVOI" "7" "01/23/2017" "\ \&" "\ \&"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
lightning-waitinvoice \- Protocol for waiting for specific payment\&.
32+
.SH "SYNOPSIS"
33+
.sp
34+
\fBwaitinvoice\fR \fIlabel\fR
35+
.SH "DESCRIPTION"
36+
.sp
37+
The \fBwaitinvoice\fR RPC command waits until a specific invoice is paid, then returns that single entry as per \fBlistinvoice\fR\&.
38+
.SH "RETURN VALUE"
39+
.sp
40+
On success, the \fIrhash\fR, \fIlabel\fR, and \fImsatoshi\fR will be returned\&.
41+
.SH "AUTHOR"
42+
.sp
43+
Christian Decker <decker\&.christian@gmail\&.com> is mainly responsible\&.
44+
.SH "SEE ALSO"
45+
.sp
46+
lightning\-waitanyinvoice(7), lightning\-listinvoice(7), lightning\-delinvoice(7), lightning\-invoice(7)
47+
.SH "RESOURCES"
48+
.sp
49+
Main web site: https://github\&.com/ElementsProject/lightning

‎doc/lightning-waitinvoice.7.txt

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
LIGHTNING-WAITINVOICE(7)
2+
========================
3+
:doctype: manpage
4+
5+
NAME
6+
----
7+
lightning-waitinvoice - Protocol for waiting for specific payment.
8+
9+
SYNOPSIS
10+
--------
11+
*waitinvoice* 'label'
12+
13+
DESCRIPTION
14+
-----------
15+
The *waitinvoice* RPC command waits until a specific invoice is paid, then
16+
returns that single entry as per *listinvoice*.
17+
18+
RETURN VALUE
19+
------------
20+
On success, the 'rhash', 'label', and 'msatoshi' will be returned.
21+
22+
//FIXME:Enumerate errors
23+
24+
AUTHOR
25+
------
26+
Christian Decker <decker.christian@gmail.com> is mainly responsible.
27+
28+
SEE ALSO
29+
--------
30+
lightning-waitanyinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7)
31+
32+
RESOURCES
33+
---------
34+
Main web site: https://github.com/ElementsProject/lightning

0 commit comments

Comments
 (0)
Please sign in to comment.