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

doc: add lightning-waitinvoice man page.

Browse Source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2017-01-23 10:39:43 +10:30
parent 69079e51a9
commit 2fb2e757ae
5 changed files with 86 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/Makefile
View File

@ -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)

2
doc/lightning-waitanyinvoice.7
View File

@ -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
doc/lightning-waitanyinvoice.7.txt
View File

@ -32,7 +32,7 @@ Rusty Russell <rusty@rustcorp.com.au> 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
---------

49
doc/lightning-waitinvoice.7 Normal file
View File

@ -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
doc/lightning-waitinvoice.7.txt Normal file
View File

@ -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 <decker.christian@gmail.com> 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