mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-06 05:49:30 +01:00
82 lines
1.9 KiB
Groff
Generated
82 lines
1.9 KiB
Groff
Generated
.TH "LIGHTNING-HELP" "7" "" "" "lightning-help"
|
|
.SH NAME
|
|
lightning-help - Command to return all information about RPC commands\.
|
|
.SH SYNOPSIS
|
|
|
|
\fBhelp\fR [\fIcommand\\\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBhelp\fR is a RPC command which is possible consult all information about the RPC commands, or a specific command if \fIcommand\fR is given\.
|
|
|
|
|
|
Note that the \fBlightning-cli\fR(1) tool will prefer to list a man page when a
|
|
specific \fIcommand\fR is specified, and will only return the JSON if the man
|
|
page is not found\.
|
|
|
|
.SH EXAMPLE JSON REQUEST
|
|
.nf
|
|
.RS
|
|
{
|
|
"id": 82,
|
|
"method": "help",
|
|
"params": {}
|
|
}
|
|
.RE
|
|
|
|
.fi
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBhelp\fR (array of objects):
|
|
.RS
|
|
.IP \[bu]
|
|
\fBcommand\fR (string): the command
|
|
.IP \[bu]
|
|
\fBcategory\fR (string): the category for this command (useful for grouping)
|
|
.IP \[bu]
|
|
\fBdescription\fR (string): a one-line description of the purpose of this command
|
|
.IP \[bu]
|
|
\fBverbose\fR (string): a full description of this command (including whether it's deprecated)
|
|
|
|
.RE
|
|
|
|
|
|
.RE
|
|
|
|
On failure, one of the following error codes may be returned:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
-32602: Error in given parameters\.
|
|
|
|
.RE
|
|
.SH EXAMPLE JSON RESPONSE
|
|
.nf
|
|
.RS
|
|
{
|
|
"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). "
|
|
}
|
|
]
|
|
}
|
|
.RE
|
|
|
|
.fi
|
|
.SH AUTHOR
|
|
|
|
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:e162d82c81f6a121839d2dfa1658014867f058fe52a100a885956f566a211a8e
|