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.
9051 Commits
55 Branches
107 Tags
38 MiB
Branch: fix-mocks
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fix-mocks'
${ noResults }
lightning/doc/lightning-listinvoices.7.md

44 lines
1.3 KiB
Raw Permalink Normal View History

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
lightning-listinvoices -- Command for querying invoice status
=============================================================
doc/manpages: replace asciidoc by markdown
5 years ago
SYNOPSIS
--------
**listinvoices** \[*label*\]
DESCRIPTION
-----------
The **listinvoices** RPC command gets the status of a specific invoice,
if it exists, or the status of all invoices if given no argument.
RETURN VALUE
------------
update docs with `payment_preimage`. Changelog-Added: JSON-RPC: `listinvoices` now displays the payment preimage if the invoice was paid.
5 years ago
On success, an array *invoices* of objects is returned. Each object contains
*label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*),
*payment\_preimage* (for paid invoices), and *expiry\_time* (a UNIX
timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any",
there will be an *msatoshi* field as a number, and *amount\_msat* as the same
number ending in *msat*. If the invoice *status* is *paid*, there will be a
*pay\_index* field and an *msatoshi\_received* field (which may be slightly
greater than *msatoshi* as some overpaying is permitted to allow clients to
obscure payment paths); there will also be an *amount\_received\_msat* field
with the same number as *msatoshi\_received* but ending in *msat*.
doc/manpages: replace asciidoc by markdown
5 years ago
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-waitinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that&#39;s how we know whether to try regenerating them or not (git doesn&#39;t store timestamps, so it can&#39;t really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
4 years ago