Browse Source

doc: rename waitinvoice manpage to waitanyinvoice.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ppa-0.6.1
Rusty Russell 8 years ago
parent
commit
df59cef3af
  1. 2
      Makefile
  2. 12
      doc/lightning-waitanyinvoice.7
  3. 10
      doc/lightning-waitanyinvoice.7.txt

2
Makefile

@ -205,7 +205,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
PROGRAMS := $(TEST_PROGRAMS)

12
doc/lightning-waitinvoice.7 → doc/lightning-waitanyinvoice.7

@ -1,13 +1,13 @@
'\" t
.\" Title: lightning-waitinvoice
.\" Title: lightning-waitanyinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 09/06/2016
.\" Date: 01/23/2017
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-WAITINVOI" "7" "09/06/2016" "\ \&" "\ \&"
.TH "LIGHTNING\-WAITANYIN" "7" "01/23/2017" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -28,13 +28,13 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-waitinvoice \- Protocol for waiting for payments\&.
lightning-waitanyinvoice \- Protocol for waiting for payments\&.
.SH "SYNOPSIS"
.sp
\fBwaitinvoice\fR [\fIlastlabel\fR]
\fBwaitanyinvoice\fR [\fIlastlabel\fR]
.SH "DESCRIPTION"
.sp
The \fBwaitinvoice\fR RPC command waits until an invoice is paid, then returns a single entry as per \fBlistinvoice\fR\&. It will not return for any invoices paid prior to or including \fIlastlabel\fR\&.
The \fBwaitanyinvoice\fR RPC command waits until an invoice is paid, then returns a single entry as per \fBlistinvoice\fR\&. It will not return for any invoices paid prior to or including \fIlastlabel\fR\&.
.sp
This is usually called iteratively: once with no arguments, then repeatedly with the returned \fIlabel\fR entry\&. This ensures that no paid invoice is missed\&.
.SH "RETURN VALUE"

10
doc/lightning-waitinvoice.7.txt → doc/lightning-waitanyinvoice.7.txt

@ -1,18 +1,18 @@
LIGHTNING-WAITINVOICE(7)
========================
LIGHTNING-WAITANYINVOICE(7)
===========================
:doctype: manpage
NAME
----
lightning-waitinvoice - Protocol for waiting for payments.
lightning-waitanyinvoice - Protocol for waiting for payments.
SYNOPSIS
--------
*waitinvoice* ['lastlabel']
*waitanyinvoice* ['lastlabel']
DESCRIPTION
-----------
The *waitinvoice* RPC command waits until an invoice is paid, then
The *waitanyinvoice* RPC command waits until an invoice is paid, then
returns a single entry as per *listinvoice*. It will not return for
any invoices paid prior to or including 'lastlabel'.
Loading…
Cancel
Save