mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 10:39:49 +01:00
c3254e6639
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.
65 lines
1.8 KiB
Groff
65 lines
1.8 KiB
Groff
.TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect"
|
||
.SH NAME
|
||
lightning-connect - Command for connecting to another lightning node
|
||
.SH SYNOPSIS
|
||
|
||
\fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR]
|
||
|
||
.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\.
|
||
|
||
|
||
The following error codes may occur:
|
||
|
||
.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
|
||
|
||
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
||
Felix \fI<fixone@gmail.com\fR> is the original author of this manpage\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-fundchannel\fR(7), \fBlightning-listpeers\fR(7),
|
||
\fBlightning-listchannels\fR(7), \fBlightning-disconnect\fR(7)
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|