diff --git a/doc/Makefile b/doc/Makefile index 173b3b03fed2..4bd0296176ff 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -7,6 +7,7 @@ doc-wrongdir: MANPAGES := doc/lightning-cli.1 \ doc/lightningd.8 \ doc/lightningd-config.5 \ + doc/lightning-addgossip.7 \ doc/lightning-autocleaninvoice.7 \ doc/lightning-check.7 \ doc/lightning-checkmessage.7 \ diff --git a/doc/index.rst b/doc/index.rst index d7f81712c935..c634e8d42352 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -29,6 +29,7 @@ c-lightning Documentation :maxdepth: 1 :caption: Manpages + lightning-addgossip lightning-autocleaninvoice lightning-check lightning-checkmessage diff --git a/doc/lightning-addgossip.7 b/doc/lightning-addgossip.7 new file mode 100644 index 000000000000..adac5d48eb76 --- /dev/null +++ b/doc/lightning-addgossip.7 @@ -0,0 +1,38 @@ +.TH "LIGHTNING-ADDGOSSIP" "7" "" "" "lightning-addgossip" +.SH NAME +lightning-addgossip - Command for injecting a gossip message (low-level) +.SH SYNOPSIS + +\fBaddgossip\fR \fImessage\fR + +.SH DESCRIPTION + +The \fBaddgossip\fR RPC command injects a hex-encoded gossip message into +the gossip daemon\. It may return an error if it is malformed, or may +update its internal state using the gossip message\. + + +Note that currently some paths will still silently reject the gossip: it +is best effort\. + + +This is particularly used by plugins which may receive channel_update +messages within error replies\. + +.SH RETURN VALUE + +On success, an empty object is returned\. + +.SH AUTHOR + +Rusty Russell \fI is mainly responsible\. + +.SH SEE ALSO + +\fBlightning-pay\fR(7) + +.SH RESOURCES + +Main web site: \fIhttps://github.com/ElementsProject/lightning\fR + +\" SHA256STAMP:40440e0a1159025d8fac68fc127029bf8539b103c0473d6bfaacd7cef5b56bea diff --git a/doc/lightning-addgossip.7.md b/doc/lightning-addgossip.7.md new file mode 100644 index 000000000000..1ff80f997f20 --- /dev/null +++ b/doc/lightning-addgossip.7.md @@ -0,0 +1,41 @@ +lightning-addgossip -- Command for injecting a gossip message (low-level) +=============================================================== + +SYNOPSIS +-------- + +**addgossip** *message* + +DESCRIPTION +----------- + +The **addgossip** RPC command injects a hex-encoded gossip message into +the gossip daemon. It may return an error if it is malformed, or may +update its internal state using the gossip message. + +Note that currently some paths will still silently reject the gossip: it +is best effort. + +This is particularly used by plugins which may receive channel_update +messages within error replies. + +RETURN VALUE +------------ + +On success, an empty object is returned. + +AUTHOR +------ + +Rusty Russell <> is mainly responsible. + +SEE ALSO +-------- + +lightning-pay(7) + +RESOURCES +--------- + +Main web site: +