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.
7880 Commits
55 Branches
107 Tags
38 MiB
Tree: a04f0fe250
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a04f0fe250'
${ noResults }
lightning/doc/lightning-delinvoice.7

36 lines
890 B
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
5 years ago
.TH "LIGHTNING-DELINVOICE" "7" "" "" "lightning-delinvoice"
.SH NAME
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-delinvoice - Command for removing an invoice
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH SYNOPSIS
JSONRPC: delinvoice: have a status argument. delinvoice was orginally documented to only allow deletion of unpaid invoices, but there might be reasons to delete paid ones or unexpired ones. But we have to avoid the race where someone pays as it's deleted: the easiest way is to have the caller tell us the status, and fail if it's wrong. Fixes: #477 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH DESCRIPTION
The \fBdelinvoice\fR RPC command removes an invoice with \fIstatus\fR as given
in \fBlistinvoices\fR\.
The caller should be particularly aware of the error case caused by the
\fIstatus\fR changing just before this command is invoked!
.SH RETURN VALUE
On success, an invoice description will be returned as per
\fBlightning-listinvoice\fR(7)\.
.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-listinvoice\fR(7), \fBlightning-waitinvoice\fR(7),
\fBlightning-invoice\fR(7), \fBlightning-delexpiredinvoice\fR(7),
\fBlightning-autocleaninvoice\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