mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00

Rusty Russell 3a49320dd1 doc: language tidyups and a few minor refinements.

Some additional detail was warranted in several places, though the
listconfigs is better off simply referring to lightningd-config.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Fixed: doc: Many missing manual pages were completed

2020-09-08 14:55:29 +09:30

1.8 KiB

Raw Blame History

lightning-help -- Command to return all information about RPC commands.

SYNOPSIS

help [*command*]

DESCRIPTION

The help is a RPC command which is possible consult all information about the RPC commands, or a specific command if command is given.

Note that the lightning-cli(1) tool will prefer to list a man page when a specific command is specified, and will only return the JSON if the man page is not found.

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "help",
  "params": {}
}

RETURN VALUE

On success, a object will be return with the following proprieties:

command: A string that represents the stucture of the command.
category: A string that represents the category.
description: A string that represents the description.
verbose: A string that represents the verbode description.

On failure, one of the following error codes may be returned:

-32602: Error in given parameters.

EXAMPLE JSON RESPONSE

{
    "help": [
      {
        "command": "autocleaninvoice [cycle_seconds] [expired_by]",
        "category": "plugin",
        "description": "Set up autoclean of expired invoices. ",
        "verbose": "Perform cleanup every {cycle_seconds} (default 3600), or disable autoclean if 0. Clean up expired invoices that have expired for {expired_by} seconds (default 86400). "
      }
    ]
}

AUTHOR

Vincenzo Palazzo <vincenzo.palazzo@protonmail.com> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning

1.8 KiB Raw Blame History