documentation: connect

Author: fixone

doc/lightning-connect.7

@@ -0,0 +1,64 @@
+'\" t
+.\"     Title: lightning-connect
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 04/26/2018
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "LIGHTNING\-CONNECT" "7" "04/26/2018" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+lightning-connect \- Command for connecting to another lightning node\&.
+.SH "SYNOPSIS"
+.sp
+\fBconnect\fR \fInode_id\fR[@(\fIip_addr\fR|\fIhostname\fR)[:\*(Aqport\*(Aq]]
+.sp
+or
+.sp
+\fBconnect\fR \fInode_id\fR[ (\fIip_addr\fR|\fIhostname\fR)[:\*(Aqport\*(Aq]]
+.SH "DESCRIPTION"
+.sp
+The \fBconnect\fR RPC command establishes a new connection with another node in the Lightning Network\&.
+.sp
+\fInode_id\fR represents the target node\(cqs public key and \fIip_addr\fR can be either IPv4 or IPv6\&.
+.sp
+If not specified the \fIport\fR is assumed to be 9375 (default lightning port)\&.
+.sp
+If neither \fIip_addr\fR or \fIhostname\fR is specified, connection will be attempted to an IP belonging to \fInode_id\fR learned through gossip with other already connected peers
+.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
+On success the response will include just the peer id (peer\(cqs public key)
+.SH "ERRORS"
+.sp
+If \fInode_id\fR or \fIip_addr\fR are invalid or if \fIhostname\fR can\(cqt be resolved to a valid IP address an error message will be returned\&. An error will also be returned if the simplified version (only \fInode_id\fR) is used and there\(cqs no published IP for the peer\&. \fBconnect\fR will make up to 10(?) attempts to connect to the peer before giving up
+.SH "AUTHOR"
+.sp
+Felix <fixone@gmail\&.com> is mainly responsible\&.
+.SH "SEE ALSO"
+.sp
+lightning\-fundchannel(7), lightning\-listpeers(7), lightning\-listchannels(7), lightning\-disconnect(7)
+.SH "RESOURCES"
+.sp
+Main web site: https://github\&.com/ElementsProject/lightning

doc/lightning-connect.7.txt

@@ -0,0 +1,64 @@
+LIGHTNING-CONNECT(7)
+====================
+:doctype: manpage
+
+NAME
+----
+lightning-connect - Command for connecting to another 
+lightning node.
+
+SYNOPSIS
+--------
+*connect* 'node_id'[@('ip_addr'|'hostname')[:'port']]
+
+or
+
+*connect* 'node_id'[ ('ip_addr'|'hostname')[:'port']]
+
+DESCRIPTION
+-----------
+The *connect* RPC command establishes a new connection 
+with another node in the Lightning Network.
+
+'node_id' represents the target node's public key and 
+'ip_addr' can be either IPv4 or IPv6. 
+
+If not specified the 'port' is assumed to be 9375 
+(default lightning port).
+
+If neither 'ip_addr' or 'hostname' is specified, 
+connection will be attempted to an IP belonging to 
+'node_id' learned through gossip with other already 
+connected peers
+
+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)
+
+
+RETURN VALUE
+------------
+On success the response will include just the peer id 
+(peer's public key)
+
+ERRORS
+------
+If 'node_id' or 'ip_addr' are invalid or if 'hostname' 
+can't be resolved to a valid IP address an error message
+will be returned. An error will also be returned if the 
+simplified version (only 'node_id') is used and there's
+no published IP for the peer. *connect* will make up to 
+10(?) attempts to connect to the peer before giving up
+
+AUTHOR
+------
+Felix <[email protected]> is mainly responsible.
+
+SEE ALSO
+--------
+lightning-fundchannel(7), lightning-listpeers(7), 
+lightning-listchannels(7), lightning-disconnect(7)
+
+RESOURCES
+---------
+Main web site: https://github.com/ElementsProject/lightning