mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00

Christian Decker c3254e6639 docs: Update manpages to be recognized correctly by mrkd

mrkd started enforcing the `name -- short description` style of top-level
headings somewhere, and was thus failing to build the man-pages. I swapped
the title and with the existing short description to make it work
again. `mrkd` will automatically infer the section from the filename so no
need to put it in the title as well.

In addition I removed the "last updated" lines at the bottom since they are
out of date at best, and misleading at the worst. If we want to keep them, I'd
suggest generating them from the commit that last touched them.

2019-09-02 16:31:36 +02:00

893 B

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, the command_to_check is returned. On failure, the relevant RPC error is returned.

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

893 B Raw Blame History Unescape Escape