mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-03 20:44:54 +01:00
6d1897b796
They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
lightning-check -- Command for verifying parameters
|
||
==============================
|
||
|
||
SYNOPSIS
|
||
--------
|
||
|
||
**check** *command\_to\_check* \[*parameters*\]
|
||
|
||
DESCRIPTION
|
||
-----------
|
||
|
||
The **check** RPC command verifies another command’s parameters without
|
||
running it.
|
||
|
||
The *command\_to\_check* is the name of the relevant command.
|
||
|
||
*parameters* is the command’s parameters.
|
||
|
||
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.
|
||
|
||
RETURN VALUE
|
||
------------
|
||
|
||
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
||
On success, an object is returned, containing:
|
||
- **command_to_check** (string): the *command_to_check* argument
|
||
|
||
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
||
|
||
AUTHOR
|
||
------
|
||
|
||
Mark Beckwith <<wythe@intrig.com>> and Rusty Russell
|
||
<<rusty@rustcorp.com.au>> are mainly responsible.
|
||
|
||
RESOURCES
|
||
---------
|
||
|
||
Main web site: <https://github.com/ElementsProject/lightning>
|
||
|
||
[comment]: # ( SHA256STAMP:47419eb2a6d8d83866773a49170f6fa6047de01435d602fa08487c59d87fb93c)
|