From d18d950a0ac3335842f7a994bb4035705776fd87 Mon Sep 17 00:00:00 2001 From: Mark Beckwith Date: Fri, 7 Dec 2018 11:31:16 -0600 Subject: [PATCH] doc: check manpage Signed-off-by: Mark Beckwith --- doc/Makefile | 1 + doc/lightning-check.7 | 52 +++++++++++++++++++++++++++++++++++++++ doc/lightning-check.7.txt | 37 ++++++++++++++++++++++++++++ 3 files changed, 90 insertions(+) create mode 100644 doc/lightning-check.7 create mode 100644 doc/lightning-check.7.txt diff --git a/doc/Makefile b/doc/Makefile index 9a1ee1940..284c50c10 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -7,6 +7,7 @@ doc-wrongdir: MANPAGES := doc/lightning-cli.1 \ doc/lightningd-config.5 \ doc/lightning-autocleaninvoice.7 \ + doc/lightning-check.7 \ doc/lightning-close.7 \ doc/lightning-connect.7 \ doc/lightning-decodepay.7 \ diff --git a/doc/lightning-check.7 b/doc/lightning-check.7 new file mode 100644 index 000000000..24e59c9e2 --- /dev/null +++ b/doc/lightning-check.7 @@ -0,0 +1,52 @@ +'\" t +.\" Title: lightning-check +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 12/07/2018 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "LIGHTNING\-CHECK" "7" "12/07/2018" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +lightning-check \- Command for verifying parameters\&. +.SH "SYNOPSIS" +.sp +\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR] +.SH "DESCRIPTION" +.sp +The \fBcheck\fR command verifies another command\(cqs parameters without running it\&. +.sp +The \fIcommand_to_check\fR is the name of the relevant command\&. +.sp +\fIparameters\fR is the command\(cqs parameters\&. +.sp +This does not guarantee successful execution of the command in all cases\&. For example, a call to \fBgetroute\fR may still fail to find a route even if checking the parameters succeeds\&. +.SH "RETURN VALUE" +.sp +On success, the \fIcommand_to_check\fR is returned\&. On failure, the relevant RPC error is returned\&. +.SH "AUTHOR" +.sp +Mark Beckwith and Rusty Russell are mainly responsible\&. +.SH "RESOURCES" +.sp +Main web site: https://github\&.com/ElementsProject/lightning diff --git a/doc/lightning-check.7.txt b/doc/lightning-check.7.txt new file mode 100644 index 000000000..32a4a2d46 --- /dev/null +++ b/doc/lightning-check.7.txt @@ -0,0 +1,37 @@ +LIGHTNING-CHECK(7) +================== +:doctype: manpage + +NAME +---- +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 and Rusty Russell +are mainly responsible. + +RESOURCES +--------- +Main web site: https://github.com/ElementsProject/lightning