mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-03 18:57:06 +01:00
Code Issues Projects Releases Wiki Activity

Add a manpage for the 'plugin' command

Browse source
This commit is contained in:
darosior 2019-07-23 01:32:15 +02:00 • committed by Rusty Russell
parent 9ddc2e0334
commit e61e0cc28b
2 changed files with 104 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
doc/lightning-plugin.7 Normal file
View file

@ -0,0 +1,56 @@
'\" t
.\" Title: lightning-plugin
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 07/23/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-PLUGIN" "7" "07/23/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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-plugin \- Manage plugins with RPC
.SH "SYNOPSIS"
.sp
\fBplugin\fR command [parameter] [second_parameter]
.SH "DESCRIPTION"
.sp
The \fBplugin\fR RPC command allows to manage plugins without having to restart lightningd\&. It takes 1 to 3 parameters: a command (start/stop/startdir/rescan/list) which describes the action to take and optionally one or two parameters which describes the plugin on which the action has to be taken\&.
.sp
The \fIstart\fR command takes a path as parameter and will load the plugin available from this path\&.
.sp
The \fIstop\fR command takes a plugin name as parameter and will kill and unload the specified plugin\&.
.sp
The \fIstartdir\fR command takes a directory path as parameter and will load all plugins this directory contains\&.
.sp
The \fIrescan\fR command starts all not\-already\-loaded plugins from the default plugins directory (by default \fI~/\&.lightning/plugins\fR)\&.
.sp
The \fIlist\fR command will return all the active plugins\&.
.SH "RETURN VALUE"
.sp
On success, this returns an array \fIplugins\fR of objects, one by plugin\&. Each object contains the name of the plugin (\fIname\fR field) and its status (\fIactive\fR boolean field)\&. Since plugins are configured asynchronously, a freshly started plugin may not appear immediately\&.
.SH "AUTHOR"
.sp
Antoine Poinsot <darosior@protonmail\&.com> is mainly responsible\&.
.SH "RESOURCES"
.sp
Main web site: https://github\&.com/ElementsProject/lightning

48
doc/lightning-plugin.7.txt Normal file
View file

@ -0,0 +1,48 @@
LIGHTNING-PLUGIN(7)
===================
:doctype: manpage
NAME
----
lightning-plugin - Manage plugins with RPC
SYNOPSIS
--------
*plugin* command [parameter] [second_parameter]
DESCRIPTION
-----------
The *plugin* RPC command allows to manage plugins without having to restart lightningd.
It takes 1 to 3 parameters: a command (start/stop/startdir/rescan/list) which describes the
action to take and optionally one or two parameters which describes the plugin on which
the action has to be taken.
The 'start' command takes a path as parameter and will load the plugin available from this
path.
The 'stop' command takes a plugin name as parameter and will kill and unload the specified
plugin.
The 'startdir' command takes a directory path as parameter and will load all plugins this
directory contains.
The 'rescan' command starts all not-already-loaded plugins from the default plugins directory
(by default '~/.lightning/plugins').
The 'list' command will return all the active plugins.
RETURN VALUE
------------
On success, this returns an array 'plugins' of objects, one by plugin. Each object contains
the name of the plugin ('name' field) and its status ('active' boolean field).
Since plugins are configured asynchronously, a freshly started plugin may not appear immediately.
AUTHOR
------
Antoine Poinsot <darosior@protonmail.com> is mainly responsible.
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning