mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
d6a5b87395
core-lightning/doc/lightning-connect.7

65 lines
1.8 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect"
.SH NAME
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 14:30:56 +02:00
lightning-connect - Command for connecting to another lightning node
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SYNOPSIS
doc: fix connect manpage parameter names and... also fixed grammar and consistency with other manpages. The names are now the same as what json_connect() expects. Signed-off-by: Mark Beckwith <wythe@intrig.com>
2019-02-08 17:53:45 +01:00
\fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH DESCRIPTION
The \fBconnect\fR RPC command establishes a new connection with another
node in the Lightning Network\.
\fIid\fR represents the target node’s public key\. As a convenience, \fIid\fR may
be of the form \fIid@host\fR or \fIid@host:port\fR\. In this case, the \fIhost\fR and
\fIport\fR parameters must be omitted\.
\fIhost\fR is the peer’s hostname or IP address\.
If not specified, the \fIport\fR defaults to 9735\.
If \fIhost\fR is not specified, the connection will be attempted to an IP
belonging to \fIid\fR obtained through gossip with other already connected
peers\.
If \fIhost\fR begins with a \fI/\fR it is interpreted as a local path, and the
connection will be made to that local socket (see \fBbind-addr\fR in
\fBlightningd-config\fR(5))\.
Connecting to a node is just the first step in opening a channel with
another node\. Once the peer is connected a channel can be opened with
\fBlightning-fundchannel\fR(7)\.
.SH RETURN VALUE
On success the peer \fIid\fR is returned\.
doc: fix connect manpage parameter names and... also fixed grammar and consistency with other manpages. The names are now the same as what json_connect() expects. Signed-off-by: Mark Beckwith <wythe@intrig.com>
2019-02-08 17:53:45 +01:00
The following error codes may occur:
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.IP \[bu]
-1: Catchall nonspecific error\. This may occur if the host is not
valid or there are problems communicating with the peer\. \fBconnect\fR
will make up to 10 attempts to connect to the peer before giving up\.
.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 14:30:56 +02:00
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Felix \fI<fixone@gmail.com\fR> is the original author of this manpage\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
.SH SEE ALSO
\fBlightning-fundchannel\fR(7), \fBlightning-listpeers\fR(7),
\fBlightning-listchannels\fR(7), \fBlightning-disconnect\fR(7)
.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 14:30:56 +02:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 02:12:44 +02:00
Reference in New Issue Copy Permalink