mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
6d1897b796
They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
43 lines
1.0 KiB
Groff
Generated
43 lines
1.0 KiB
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, an object is returned, containing:
|
||
|
||
.RS
|
||
.IP \[bu]
|
||
\fBcommand_to_check\fR (string): the \fIcommand_to_check\fR argument
|
||
|
||
.RE
|
||
.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
|
||
|
||
\" SHA256STAMP:3a0e3635cb3ec89d67ec13485220e16e362ed8588213382c8ae5cf4f6f1e0523
|