40 lines
1.1 KiB
Groff
40 lines
1.1 KiB
Groff
.\" -*- mode: troff; coding: utf-8 -*-
|
|
.TH "LIGHTNING-CHECK" "7" "" "Core Lightning 0.12.1" ""
|
|
.SH
|
|
NAME
|
|
.LP
|
|
lightning-check -- Command for verifying parameters
|
|
.SH
|
|
SYNOPSIS
|
|
.LP
|
|
\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
|
|
.SH
|
|
DESCRIPTION
|
|
.LP
|
|
The \fBcheck\fR RPC command verifies another command's parameters without
|
|
running it.
|
|
.PP
|
|
The \fIcommand_to_check\fR is the name of the relevant command.
|
|
.PP
|
|
\fIparameters\fR is the command's parameters.
|
|
.PP
|
|
This does not guarantee successful execution of the command in all
|
|
cases. For example, a call to lightning-getroute(7) may still fail to
|
|
find a route even if checking the parameters succeeds.
|
|
.SH
|
|
RETURN VALUE
|
|
.LP
|
|
On success, an object is returned, containing:
|
|
.IP "\(bu" 2
|
|
\fBcommand_to_check\fR (string): the \fIcommand\fIto\fIcheck\fR argument
|
|
.SH
|
|
AUTHOR
|
|
.LP
|
|
Mark Beckwith <\fIwythe@intrig.com\fR> and Rusty Russell
|
|
<\fIrusty@rustcorp.com.au\fR> are mainly responsible.
|
|
.SH
|
|
RESOURCES
|
|
.LP
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
\" SHA256STAMP:0c64dc2e2e56f94408131d71615d307559019b42e91a613693578de09c7ce3fc
|