2019-08-10 01:12:44 +01:00
|
|
|
|
.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
|
|
|
|
|
|
.SH NAME
|
|
|
|
|
|
lightning-check - Command for verifying parameters
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
|
|
2018-12-07 17:31:16 +00:00
|
|
|
|
\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
|
|
|
|
|
.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
|
|
|
|
|
|
|
2019-08-31 13:30:56 +01:00
|
|
|
|
Mark Beckwith \fI<wythe@intrig.com\fR> and Rusty Russell
|
|
|
|
|
|
\fI<rusty@rustcorp.com.au\fR> are mainly responsible\.
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
|
|
|
|
|
.SH RESOURCES
|
|
|
|
|
|
|
2019-08-31 13:30:56 +01:00
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
