mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-08 14:50:26 +01:00
Code Issues Projects Releases Wiki Activity
3cf98085d4
core-lightning/doc/lightning-check.7.md
Rusty Russell 3bc5d47aa2 doc/schemas: add some simple schemas and generate manpages from them 
addgossip, check, createinvoice, createonion.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-27 20:28:49 +09:30

1.1 KiB
Raw Blame History

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 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