core-lightning/doc/lightning-check.7
Rusty Russell a00179d557 doc, wiregen: use SHA256 stamps instead of git versions.
This should be more robust in future: we SHA256 all of the deps.
For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 21:33:26 -05:00

39 lines
1014 B
Groff
Generated
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.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 \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:8ff7c586849eae5646f182b088351b4a5baa61e9e628a31763a6647e74a7fc0a