mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-27 09:04:40 +01:00

niftynei ba7d4a8f6b make-schema: don't include tools/fromschema.py in SHASUMS

We were including the entire list of prerequisites when generating a
shastamp, which for schemas includes the `tools/fromschema.py` doc.

This meant all of our shasums were updating anytime this tool file
changed.

Instead, we just include the first prerequisite.

See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables

2022-07-14 12:24:48 -05:00

2.0 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, an object is returned, containing:

help (array of objects):
- command (string): the command
- category (string): the category for this command (useful for grouping)
- description (string): a one-line description of the purpose of this command
- verbose (string): a full description of this command (including whether it's deprecated)

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 comment: # ( SHA256STAMP:881f00fb7943bc1655c054488643a4da37742b6705924f0ba33366e8cf3f2b93)

2.0 KiB Raw Blame History