vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-check.7

43 lines
1.0 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
.SH NAME
lightning-check - Command for verifying parameters
.SH SYNOPSIS
doc: check manpage Signed-off-by: Mark Beckwith <wythe@intrig.com>
2018-12-07 17:31:16 +00:00
\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH DESCRIPTION
The \fBcheck\fR RPC command verifies another command’s parameters without
running it\.
The \fIcommand_to_check\fR is the name of the relevant command\.
\fIparameters\fR is the command’s parameters\.
This does not guarantee successful execution of the command in all
cases\. For example, a call to \fBlightning-getroute\fR(7) may still fail to
find a route even if checking the parameters succeeds\.
.SH RETURN VALUE
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-26 06:50:01 +01:00
On success, an object is returned, containing:
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
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-26 06:50:01 +01:00
.RS
.IP \[bu]
\fBcommand_to_check\fR (string): the \fIcommand_to_check\fR argument
.RE
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH AUTHOR
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-08-31 13:30:56 +01:00
Mark Beckwith \fI<wythe@intrig.com\fR> and Rusty Russell
\fI<rusty@rustcorp.com.au\fR> are mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH RESOURCES
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-08-31 13:30:56 +01:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
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-26 06:50:01 +01:00
\" SHA256STAMP:9e78651117d3546edaf5150621630ee5dc4ccefd6e6a17b52b9dc8f86e8ba0c9