core-lightning/doc/lightning-signmessage.7
Rusty Russell 6d1897b796 doc: fix GH/readthedocs rendering of manual pages.
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-05 15:02:17 +02:00

44 lines
1.2 KiB
Groff

.TH "LIGHTNING-SIGNMESSAGE" "7" "" "" "lightning-signmessage"
.SH NAME
lightning-signmessage - Command to create a signature from this node
.SH SYNOPSIS
\fBsignmessage\fR \fImessage\fR
.SH DESCRIPTION
The \fBsignmessage\fR RPC command creates a digital signature of
\fImessage\fR using this node's secret key\. A receiver who knows your
node's \fIid\fR and the \fImessage\fR can be sure that the resulting signature could
only be created by something with access to this node's secret key\.
\fImessage\fR must be less that 65536 characters\.
.SH RETURN VALUE
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBsignature\fR (hex): The signature (always 128 characters)
.IP \[bu]
\fBrecid\fR (hex): The recovery id (0, 1, 2 or 3) (always 2 characters)
.IP \[bu]
\fBzbase\fR (string): \fIsignature\fR and \fIrecid\fR encoded in a style compatible with \fBlnd\fR's \fBSignMessageRequest\fR (\fIhttps://api.lightning.community/#grpc-request-signmessagerequest\fR)
.RE
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-checkmessage\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:7ef4acf3cc994edafd0d97908a00fb14096de46fba13f2af87869a016c1fad1f