From 435843acfa9d1fe1736c0dabccace7363c03e51a Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Tue, 12 Mar 2019 11:10:59 +1030 Subject: [PATCH] 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 1diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7 index f143563ca..53619c44f 100644 --- doc/lightning-connect.7 | 6 ++++-- doc/lightning-connect.7.txt | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7 index f143563ca..53619c44f 100644 --- a/doc/lightning-connect.7 +++ b/doc/lightning-connect.7 @@ -2,12 +2,12 @@ .\" Title: lightning-connect .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 02/11/2019 +.\" Date: 03/12/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-CONNECT" "7" "02/11/2019" "\ \&" "\ \&" +.TH "LIGHTNING\-CONNECT" "7" "03/12/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -44,6 +44,8 @@ If not specified, the \fIport\fR defaults to 9375\&. .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\&. .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)\&. .SH "RETURN VALUE" .sp diff --git a/doc/lightning-connect.7.txt b/doc/lightning-connect.7.txt index e987dcd60..a1a3ddf4a 100644 --- a/doc/lightning-connect.7.txt +++ b/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 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 a channel with another node. Once the peer is connected a channel can be opened with