Browse Source

doc: document UNIX domain sockets in lightning-connect.

We document how to bind to them, just not how to connect to them.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>

1diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7
index f143563ca..53619c44f 100644
issue-2504
Rusty Russell 6 years ago
committed by Christian Decker
parent
commit
435843acfa
  1. 6
      doc/lightning-connect.7
  2. 4
      doc/lightning-connect.7.txt

6
doc/lightning-connect.7

@ -2,12 +2,12 @@
.\" Title: lightning-connect .\" Title: lightning-connect
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/11/2019 .\" Date: 03/12/2019
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-CONNECT" "7" "02/11/2019" "\ \&" "\ \&" .TH "LIGHTNING\-CONNECT" "7" "03/12/2019" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -44,6 +44,8 @@ If not specified, the \fIport\fR defaults to 9375\&.
.sp .sp
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 is not specified, the connection will be attempted to an IP belonging to \fIid\fR obtained through gossip with other already connected peers\&.
.sp .sp
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 lightningd\-config(5))\&.
.sp
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 lightning\-fundchannel(7)\&. 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 lightning\-fundchannel(7)\&.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.sp .sp

4
doc/lightning-connect.7.txt

@ -29,6 +29,10 @@ connection will be attempted to an IP belonging to
'id' obtained through gossip with other already 'id' obtained through gossip with other already
connected peers. connected peers.
If 'host' begins with a '/' it is interpreted as a local path,
and the connection will be made to that local socket (see *bind-addr*
in lightningd-config(5)).
Connecting to a node is just the first step in opening Connecting to a node is just the first step in opening
a channel with another node. a channel with another node.
Once the peer is connected a channel can be opened with Once the peer is connected a channel can be opened with

Loading…
Cancel
Save