mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 10:39:49 +01:00
Code Issues Projects Releases Wiki Activity
76f27f47dc
core-lightning/doc/lightning-autocleaninvoice.7

45 lines
1.1 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.TH "LIGHTNING-AUTOCLEANINVOICE" "7" "" "" "lightning-autocleaninvoice"
.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.
2019-08-31 14:30:56 +02:00
lightning-autocleaninvoice - Set up auto-delete of expired invoice
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
lightning-autocleaninvoice - Set up auto-delete of expired invoice
.SH SYNOPSIS
lightning-autocleaninvoice.7: Properly generate instead of using an empty file. Strange behavior where `a2x` sometimes does not work at all.
2018-04-16 14:30:07 +02:00
\fBautocleaninvoice\fR [\fIcycle_seconds\fR] [\fIexpired_by\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH DESCRIPTION
The \fBautocleaninvoice\fR RPC command sets up automatic cleaning of
expired invoices\.
Autoclean will be done every \fIcycle_seconds\fR seconds\. Setting
\fIcycle_seconds\fR to 0 disables autoclean\. If not specified, this
defaults to 3600 (one hour)\.
Every autoclean cycle, expired invoices, which have already been expired
for at least \fIexpired_by\fR seconds, will be deleted\. If \fIexpired_by\fR is
not specified, this defaults to 86400 (one day)\.
On startup of the daemon, no autoclean is set up\.
.SH RETURN VALUE
On success, an empty object is returned\.
.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.
2019-08-31 14:30:56 +02:00
ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SEE ALSO
\fBlightning-delexpiredinvoice\fR(7), \fBlightning-delinvoice\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 "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.
2019-08-31 14:30:56 +02:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
Reference in New Issue Copy Permalink