mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
39 lines
1.4 KiB
Groff
39 lines
1.4 KiB
Groff
.TH "LIGHTNING-LISTINVOICES" "7" "" "" "lightning-listinvoices"
|
|
.SH NAME
|
|
lightning-listinvoices - Command for querying invoice status
|
|
.SH SYNOPSIS
|
|
|
|
\fBlistinvoices\fR [\fIlabel\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBlistinvoices\fR RPC command gets the status of a specific invoice,
|
|
if it exists, or the status of all invoices if given no argument\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an array \fIinvoices\fR of objects is returned\. Each object
|
|
contains \fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or
|
|
\fIexpired\fR), and \fIexpiry_time\fR (a UNIX timestamp)\. If the \fImsatoshi\fR
|
|
argument to \fBlightning-invoice\fR(7) was not "any", there will be an
|
|
\fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same number
|
|
ending in \fImsat\fR\. If the invoice \fIstatus\fR is \fIpaid\fR, there will be a
|
|
\fIpay_index\fR field and an \fImsatoshi_received\fR field (which may be
|
|
slightly greater than \fImsatoshi\fR as some overpaying is permitted to
|
|
allow clients to obscure payment paths); there will also be an
|
|
\fIamount_received_msat\fR field with the same number as
|
|
\fImsatoshi_received\fR but ending in \fImsat\fR\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-waitinvoice\fR(7), \fBlightning-delinvoice\fR(7), \fBlightning-invoice\fR(7)\.
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|