mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +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.
38 lines
934 B
Groff
Generated
38 lines
934 B
Groff
Generated
.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
|
||
.SH NAME
|
||
lightning-check - Command for verifying parameters
|
||
.SH SYNOPSIS
|
||
|
||
\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
|
||
|
||
.SH DESCRIPTION
|
||
|
||
The \fBcheck\fR RPC command verifies another command’s parameters without
|
||
running it\.
|
||
|
||
|
||
The \fIcommand_to_check\fR is the name of the relevant command\.
|
||
|
||
|
||
\fIparameters\fR is the command’s parameters\.
|
||
|
||
|
||
This does not guarantee successful execution of the command in all
|
||
cases\. For example, a call to \fBlightning-getroute\fR(7) may still fail to
|
||
find a route even if checking the parameters succeeds\.
|
||
|
||
.SH RETURN VALUE
|
||
|
||
On success, the \fIcommand_to_check\fR is returned\. On failure, the
|
||
relevant RPC error is returned\.
|
||
|
||
.SH AUTHOR
|
||
|
||
Mark Beckwith \fI<wythe@intrig.com\fR> and Rusty Russell
|
||
\fI<rusty@rustcorp.com.au\fR> are mainly responsible\.
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|