Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,23 @@ doc-wrongdir:
MANPAGES := doc/lightning-cli.1 \
doc/lightning-autocleaninvoice.7 \
doc/lightning-close.7 \
doc/lightning-connect.7 \
doc/lightning-decodepay.7 \
doc/lightning-delexpiredinvoice.7 \
doc/lightning-delinvoice.7 \
doc/lightning-getroute.7 \
doc/lightning-invoice.7 \
doc/lightning-listfunds.7 \
doc/lightning-listinvoices.7 \
doc/lightning-listpayments.7 \
doc/lightning-newaddr.7 \
doc/lightning-pay.7 \
doc/lightning-sendpay.7 \
doc/lightning-waitinvoice.7 \
doc/lightning-waitanyinvoice.7 \
doc/lightning-waitsendpay.7
doc/lightning-waitsendpay.7 \
doc/lightning-withdraw.7


doc-all: $(MANPAGES)

Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-close.7
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-close \- Protocol for closing channels with direct peers
lightning-close \- Command for closing channels with direct peers
.SH "SYNOPSIS"
.sp
\fBclose\fR \fIid\fR [\fIforce\fR] [\fItimeout\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-close.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-CLOSE(7)

NAME
----
lightning-close - Protocol for closing channels with direct peers
lightning-close - Command for closing channels with direct peers

SYNOPSIS
--------
Expand Down
64 changes: 64 additions & 0 deletions doc/lightning-connect.7
Original file line number Diff line number Diff line change
@@ -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
64 changes: 64 additions & 0 deletions doc/lightning-connect.7.txt
Original file line number Diff line number Diff line change
@@ -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 <fixone@gmail.com> 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
6 changes: 3 additions & 3 deletions doc/lightning-decodepay.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-decodepay
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 04/05/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DECODEPAY" "7" "04/05/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DECODEPAY" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-decodepay \- Protocol for decoding a bolt11 string (low\-level)
lightning-decodepay \- Command for decoding a bolt11 string (low\-level)
.SH "SYNOPSIS"
.sp
\fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-decodepay.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DECODEPAY(7)

NAME
----
lightning-decodepay - Protocol for decoding a bolt11 string (low-level)
lightning-decodepay - Command for decoding a bolt11 string (low-level)


SYNOPSIS
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-delexpiredinvoice.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-delexpiredinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/17/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DELEXPIRE" "7" "03/17/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DELEXPIRE" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-delexpiredinvoice \- Protocol for removing expired invoices\&.
lightning-delexpiredinvoice \- Command for removing expired invoices\&.
.SH "SYNOPSIS"
.sp
\fBdelexpiredinvoice\fR [\fImaxexpirytime\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-delexpiredinvoice.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DELEXPIREDINVOICE(7)

NAME
----
lightning-delexpiredinvoice - Protocol for removing expired invoices.
lightning-delexpiredinvoice - Command for removing expired invoices.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-delinvoice.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-delinvoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/17/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-DELINVOIC" "7" "03/17/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-DELINVOIC" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-delinvoice \- Protocol for removing an invoice\&.
lightning-delinvoice \- Command for removing an invoice\&.
.SH "SYNOPSIS"
.sp
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-delinvoice.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-DELINVOICE(7)

NAME
----
lightning-delinvoice - Protocol for removing an invoice.
lightning-delinvoice - Command for removing an invoice.

SYNOPSIS
--------
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-getroute.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/19/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-GETROUTE" "7" "02/19/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-GETROUTE" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-getroute \- Protocol for routing a payment (low\-level)\&.
lightning-getroute \- Command for routing a payment (low\-level)\&.
.SH "SYNOPSIS"
.sp
\fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR] [\fIfuzzpercent\fR] [\fIseed\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-getroute.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-GETROUTE(7)

NAME
----
lightning-getroute - Protocol for routing a payment (low-level).
lightning-getroute - Command for routing a payment (low-level).


SYNOPSIS
Expand Down
6 changes: 3 additions & 3 deletions doc/lightning-invoice.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-invoice
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 04/23/2018
.\" Date: 04/26/2018
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-INVOICE" "7" "04/23/2018" "\ \&" "\ \&"
.TH "LIGHTNING\-INVOICE" "7" "04/26/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand All @@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lightning-invoice \- Protocol for accepting payments\&.
lightning-invoice \- Command for accepting payments\&.
.SH "SYNOPSIS"
.sp
\fBinvoice\fR \fImsatoshi\fR \fIlabel\fR \fIdescription\fR [\fIexpiry\fR] [\fIfallbacks\fR] [\fIpreimage\fR]
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-invoice.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LIGHTNING-INVOICE(7)

NAME
----
lightning-invoice - Protocol for accepting payments.
lightning-invoice - Command for accepting payments.

SYNOPSIS
--------
Expand Down
Loading