aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-21 16:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: document UNIX domain sockets in lightning-connect.

Browse Source 
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
This commit is contained in:
Rusty Russell
2019-03-12 11:10:59 +10:30
committed by Christian Decker
parent 1069f48082
commit 435843acfa
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/lightning-connect.7
View File

@@ -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
View File

@@ -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