lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6573 Commits
55 Branches
107 Tags
38 MiB
Tree: 063b319da1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '063b319da1'
${ noResults }
lightning/doc/lightning-listinvoices.7

39 lines
1.4 KiB
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
5 years ago
.TH "LIGHTNING-LISTINVOICES" "7" "" "" "lightning-listinvoices"
.SH NAME
lightning-listinvoices - Command for querying invoice status
.SH SYNOPSIS
JSONRPC: Make listinvoice an deprecated alias for listinvoices. This matches the other names, and also the return value is about to change. This will be removed before release! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
\fBlistinvoices\fR [\fIlabel\fR]
doc/manpages: regenerate manpages using markdown templates
5 years ago
.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
docs: Update manpages to be recognized correctly by mrkd 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.
5 years ago
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH SEE ALSO
\fBlightning-waitinvoice\fR(7), \fBlightning-delinvoice\fR(7), \fBlightning-invoice\fR(7)\.
.SH RESOURCES
docs: Update manpages to be recognized correctly by mrkd 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 &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
5 years ago