From 561a66354b89dff486a43b14a6729137ce8cb14a Mon Sep 17 00:00:00 2001 From: Michael Hawkins Date: Mon, 3 Dec 2018 05:20:25 +0000 Subject: [PATCH] Man page for lightning-disconnect created --- doc/Makefile | 1 + doc/lightning-disconnect.7 | 84 ++++++++++++++++++++++++++++++++++ doc/lightning-disconnect.7.txt | 55 ++++++++++++++++++++++ 3 files changed, 140 insertions(+) create mode 100644 doc/lightning-disconnect.7 create mode 100644 doc/lightning-disconnect.7.txt diff --git a/doc/Makefile b/doc/Makefile index a6dd2fb7f..d5b3722ec 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -12,6 +12,7 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightning-decodepay.7 \ doc/lightning-delexpiredinvoice.7 \ doc/lightning-delinvoice.7 \ + doc/lightning-disconnect.7 \ doc/lightning-fundchannel.7 \ doc/lightning-getroute.7 \ doc/lightning-invoice.7 \ diff --git a/doc/lightning-disconnect.7 b/doc/lightning-disconnect.7 new file mode 100644 index 000000000..a6c5fad76 --- /dev/null +++ b/doc/lightning-disconnect.7 @@ -0,0 +1,84 @@ +'\" t +.\" Title: lightning-disconnect +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 12/04/2018 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "LIGHTNING\-DISCONNEC" "7" "12/04/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-disconnect \- Command for disconnecting from another lightning node\&. +.SH "SYNOPSIS" +.sp +\fBdisconnect\fR \fIid\fR +.SH "DESCRIPTION" +.sp +The disconnect RPC command closes an existing connection to a peer, identified by \fIid\fR, in the Lightning Network, as long as it doesn\(cqt have an active channel\&. +.sp +The \fIid\fR can be discovered in the output of the listpeers command, which returns a set of peers: +.sp +.if n \{\ +.RS 4 +.\} +.nf +{ + "peers": [ + { + "id": "0563aea81\&.\&.\&.", + "connected": true, + \&.\&.\&. + } + ] +} +.fi +.if n \{\ +.RE +.\} +.sp +Passing the \fIid\fR attribute of a peer to lightning\-disconnect will terminate the connection\&. +.SH "RETURN VALUE" +.sp +On success, an empty object is returned\&. +.SH "ERRORS" +.sp +If \fIid\fR is invalid, an error message will be returned: +.sp +.if n \{\ +.RS 4 +.\} +.nf +{ "code" : \-1, "message" : "Peer not connected" } +.fi +.if n \{\ +.RE +.\} +.SH "AUTHOR" +.sp +Michael Hawkins \&. +.SH "SEE ALSO" +.sp +lightning\-connect(1), lightning\-listpeers(1) +.SH "RESOURCES" +.sp +Main web site: https://github\&.com/ElementsProject/lightning diff --git a/doc/lightning-disconnect.7.txt b/doc/lightning-disconnect.7.txt new file mode 100644 index 000000000..c47f2320a --- /dev/null +++ b/doc/lightning-disconnect.7.txt @@ -0,0 +1,55 @@ +LIGHTNING-DISCONNECT(7) +======================= +:doctype: manpage + +NAME +---- +lightning-disconnect - Command for disconnecting from another lightning node. + +SYNOPSIS +-------- +*disconnect* 'id' + +DESCRIPTION +----------- +The disconnect RPC command closes an existing connection to a +peer, identified by 'id', in the Lightning Network, as long as it +doesn't have an active channel. + +The 'id' can be discovered in the output of the listpeers +command, which returns a set of peers: + + { + "peers": [ + { + "id": "0563aea81...", + "connected": true, + ... + } + ] + } + +Passing the 'id' attribute of a peer to 'disconnect' will terminate +the connection. + +RETURN VALUE +------------ +On success, an empty object is returned. + +ERRORS +------ +If 'id' is invalid, an error message will be returned: + + { "code" : -1, "message" : "Peer not connected" } + +AUTHOR +------ +Michael Hawkins . + +SEE ALSO +-------- +lightning-connect(1), lightning-listpeers(1) + +RESOURCES +--------- +Main web site: https://github.com/ElementsProject/lightning