mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-03-11 01:27:58 +01:00
Created listpeers asciidoc, generated manpage using a2x and updated Makefile
This commit is contained in:
Michael Hawkins
Rusty Russell
parent
be7674ed6c
commit
1c3b8c8ec5
3 changed files with 219 additions and 0 deletions
|
|
@ -19,6 +19,7 @@ MANPAGES := doc/lightning-cli.1 \
|
|||
doc/lightning-listfunds.7 \
|
||||
doc/lightning-listinvoices.7 \
|
||||
doc/lightning-listpayments.7 \
|
||||
doc/lightning-listpeers.7 \
|
||||
doc/lightning-newaddr.7 \
|
||||
doc/lightning-pay.7 \
|
||||
doc/lightning-sendpay.7 \
|
||||
|
|
|
|||
148
doc/lightning-listpeers.7
Normal file
148
doc/lightning-listpeers.7
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
'\" t
|
||||
.\" Title: lightning-listpeers
|
||||
.\" Author: [see the "AUTHOR" section]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
||||
.\" Date: 12/07/2018
|
||||
.\" Manual: \ \&
|
||||
.\" Source: \ \&
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "LIGHTNING\-LISTPEERS" "7" "12/07/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-listpeers \- Command for returning data on connected lightning nodes\&.
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
\fBlistpeers\fR [\fIid\fR]
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
The \fBlistpeers\fR RPC command returns data on nodes that are connected or are not connected but have open channels with this node\&.
|
||||
.sp
|
||||
Once a connection to another lightning node has been established, using the \fBconnect\fR command, data on the node can be returned using \fBlistpeers\fR and the \fIid\fR that was used with the \fBconnect\fR command\&.
|
||||
.sp
|
||||
If no \fIid\fR is supplied, then data on all lightning nodes that are connected, or not connected but have open channels with this node, are returned\&.
|
||||
.sp
|
||||
Supplying \fIid\fR will filter the results to only return data on a node with a matching \fIid\fR, if one exists\&.
|
||||
.sp
|
||||
If a channel is open with a node and the connection has been lost, then the node will still appear in the output of the command and the value of the \fIconnected\fR attribute of the node will be "false"\&.
|
||||
.sp
|
||||
The channel will remain open for a set blocktime, after which if the connection has not been re\-established, the channel will close and the node will no longer appear in the command output\&.
|
||||
.SH "RETURN VALUE"
|
||||
.sp
|
||||
On success, an object with a "peers" key is returned containing a list of 0 or more objects\&.
|
||||
.sp
|
||||
Each object in the list contains the following data:
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fIid\fR
|
||||
: The unique id of the peer
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fIconnected\fR
|
||||
: A boolean value showing the connection status
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fInetaddr\fR
|
||||
: A list of network addresses the node is listening on
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fIglobalfeatures\fR
|
||||
: Bit flags showing supported global features (BOLT #9)
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fIlocalfeatures\fR
|
||||
: Bit flags showing supported local features (BOLT #9)
|
||||
.RE
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
\fIchannels\fR
|
||||
: An list of channel id\(cqs open on the peer
|
||||
.RE
|
||||
.sp
|
||||
If \fIid\fR is supplied and no matching nodes are found, a "peers" object with an empty list is returned\&.
|
||||
.SH "ERRORS"
|
||||
.sp
|
||||
If \fIid\fR is not a valid public key, an error message will be returned:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
{ "code" : \-32602, "message" : "\*(Aqid\*(Aq should be a pubkey, not \*(Aq\&.\&.\&.\*(Aq" }
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.SH "AUTHOR"
|
||||
.sp
|
||||
Michael Hawkins <michael\&.hawkins@protonmail\&.com>\&.
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
lightning\-connect(7)
|
||||
.SH "RESOURCES"
|
||||
.sp
|
||||
Main web site: https://github\&.com/ElementsProject/lightning Lightning RFC site (BOLT #9): https://github\&.com/lightningnetwork/lightning\-rfc/blob/master/09\-features\&.md
|
||||
70
doc/lightning-listpeers.7.txt
Normal file
70
doc/lightning-listpeers.7.txt
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
LIGHTNING-LISTPEERS(7)
|
||||
=======================
|
||||
:doctype: manpage
|
||||
|
||||
NAME
|
||||
----
|
||||
lightning-listpeers - Command for returning data on connected lightning nodes.
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
*listpeers* ['id']
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
The *listpeers* RPC command returns data on nodes that are connected or are not
|
||||
connected but have open channels with this node.
|
||||
|
||||
Once a connection to another lightning node has been established, using the
|
||||
*connect* command, data on the node can be returned using *listpeers* and the
|
||||
'id' that was used with the *connect* command.
|
||||
|
||||
If no 'id' is supplied, then data on all lightning nodes that are connected,
|
||||
or not connected but have open channels with this node, are returned.
|
||||
|
||||
Supplying 'id' will filter the results to only return data on a node with a
|
||||
matching 'id', if one exists.
|
||||
|
||||
If a channel is open with a node and the connection has been lost, then the
|
||||
node will still appear in the output of the command and the value of the
|
||||
'connected' attribute of the node will be "false".
|
||||
|
||||
The channel will remain open for a set blocktime, after which if the connection
|
||||
has not been re-established, the channel will close and the node will no longer
|
||||
appear in the command output.
|
||||
|
||||
RETURN VALUE
|
||||
------------
|
||||
On success, an object with a "peers" key is returned containing a list of 0 or
|
||||
more objects.
|
||||
|
||||
Each object in the list contains the following data:
|
||||
|
||||
- 'id' : The unique id of the peer
|
||||
- 'connected' : A boolean value showing the connection status
|
||||
- 'netaddr' : A list of network addresses the node is listening on
|
||||
- 'globalfeatures' : Bit flags showing supported global features (BOLT #9)
|
||||
- 'localfeatures' : Bit flags showing supported local features (BOLT #9)
|
||||
- 'channels' : An list of channel id's open on the peer
|
||||
|
||||
If 'id' is supplied and no matching nodes are found, a "peers" object with an
|
||||
empty list is returned.
|
||||
|
||||
ERRORS
|
||||
------
|
||||
If 'id' is not a valid public key, an error message will be returned:
|
||||
|
||||
{ "code" : -32602, "message" : "'id' should be a pubkey, not '...'" }
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
Michael Hawkins <michael.hawkins@protonmail.com>.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
lightning-connect(7)
|
||||
|
||||
RESOURCES
|
||||
---------
|
||||
Main web site: https://github.com/ElementsProject/lightning
|
||||
Lightning RFC site (BOLT #9): https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md
|
||||
Loading…
Add table
Reference in a new issue