core-lightning/doc/lightning-check.7.md
Rusty Russell b2148d0eab docs: handle "added": "version" and "deprecated": "version" from schemas.
This means we will document deprecations and additions, rather than just
pretending they've always been that way!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-11 12:51:18 +10:30

1.1 KiB

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

On success, an object is returned, containing:

  • command_to_check (string): the command_to_check argument

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