forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlightning-check.7
44 lines (23 loc) · 1020 Bytes
/
lightning-check.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.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, the \fIcommand_to_check\fR is returned\. On failure, the
relevant RPC error is returned\.
.SH AUTHOR
Mark Beckwith \fBNone\fR (\fI<[email protected]\fR)> and Rusty Russell
\fBNone\fR (\fI<[email protected]\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