forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add lightning-waitinvoice man page.
Signed-off-by: Rusty Russell <[email protected]>
- Loading branch information
1 parent
69079e5
commit 2fb2e75
Showing
5 changed files
with
86 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
--------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |