c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
1.4 KiB
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