core-lightning/doc/lightning-check.7

45 lines
1020 B
Groff
Raw Normal View History

.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 commands parameters without
running it\.
The \fIcommand_to_check\fR is the name of the relevant command\.
\fIparameters\fR is the commands 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 \fBNone\fR (\fI<wythe@intrig.com\fR)> and Rusty Russell
\fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> are mainly responsible\.
.SH RESOURCES
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-04-30 17:12:10 CEST