mirror of
https://github.com/aljazceru/lightning.git
synced 2026-01-22 23:34:21 +01:00
8f1164365e
You can't start a list without a paragraph separator.
```diff
--- /tmp/before 2022-07-20 22:02:23.485372596 +0930
+++ /tmp/after 2022-07-20 22:02:33.745528456 +0930
@@ -21,12 +21,16 @@
On startup of the daemon, no autoclean is set up.
RETURN VALUE
- On success, an object is returned, containing: - enabled (boolean):
- whether invoice autocleaning is active
+ On success, an object is returned, containing:
- If enabled is true: - expired_by (u64): how long an invoice must be ex‐
- pired (seconds) before we delete it - cycle_seconds (u64): how long an
- invoice must be expired (seconds) before we delete it
+ • enabled (boolean): whether invoice autocleaning is active
+
+ If enabled is true:
+
+ • expired_by (u64): how long an invoice must be expired (seconds) be‐
+ fore we delete it
+ • cycle_seconds (u64): how long an invoice must be expired (seconds)
+ before we delete it
AUTHOR
ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible.
```
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
88 lines
3.2 KiB
Markdown
88 lines
3.2 KiB
Markdown
lightning-plugin -- Manage plugins with RPC
|
|
===========================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**plugin** *subcommand* [plugin|directory] [*options*] ...
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **plugin** RPC command command can be used to control dynamic plugins,
|
|
i.e. plugins that declared themself "dynamic" (in getmanifest).
|
|
|
|
*subcommand* can be **start**, **stop**, **startdir**, **rescan** or **list** and
|
|
determines what action is taken
|
|
|
|
*plugin* is the *path* or *name* of a plugin executable to start or stop
|
|
|
|
*directory* is the *path* of a directory containing plugins
|
|
|
|
*options* are optional *keyword=value* options passed to plugin, can be repeated
|
|
|
|
*subcommand* **start** takes a *path* to an executable as argument and starts it as plugin.
|
|
*path* may be an absolute path or a path relative to the plugins directory (default *~/.lightning/plugins*).
|
|
If the plugin is already running and the executable (checksum) has changed, the plugin is
|
|
killed and restarted except if its an important (or builtin) plugin.
|
|
If the plugin doesn't complete the "getmanifest" and "init" handshakes within 60 seconds,
|
|
the command will timeout and kill the plugin.
|
|
Additional *options* may be passed to the plugin, but requires all parameters to
|
|
be passed as keyword=value pairs, for example:
|
|
`lightning-cli -k plugin subcommand=start plugin=helloworld.py greeting='A crazy'`
|
|
(using the `-k|--keyword` option is recommended)
|
|
|
|
*subcommand* **stop** takes a plugin executable *path* or *name* as argument and stops the plugin.
|
|
If the plugin subscribed to "shutdown", it may take up to 30 seconds before this
|
|
command returns. If the plugin is important and dynamic, this will shutdown `lightningd`.
|
|
|
|
*subcommand* **startdir** starts all executables it can find in *directory* (excl. subdirectories)
|
|
as plugins. Checksum and timeout behavior as in **start** applies.
|
|
|
|
*subcommand* **rescan** starts all plugins in the default plugins directory (default *~/.lightning/plugins*)
|
|
that are not already running. Checksum and timeout behavior as in **start** applies.
|
|
|
|
*subcommand* **list** lists all running plugins (incl. non-dynamic)
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
On success, an object is returned, containing:
|
|
|
|
- **command** (string): the subcommand this is responding to (one of "start", "stop", "rescan", "startdir", "list")
|
|
|
|
If **command** is "start", "startdir", "rescan" or "list":
|
|
|
|
- **plugins** (array of objects):
|
|
- **name** (string): full pathname of the plugin
|
|
- **active** (boolean): status; plugin completed init and is operational, plugins are configured asynchronously.
|
|
- **dynamic** (boolean): plugin can be stopped or started without restarting lightningd
|
|
|
|
If **command** is "stop":
|
|
|
|
- **result** (string): A message saying it successfully stopped
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
On error, the reason why the action could not be taken upon the
|
|
plugin is returned.
|
|
|
|
SEE ALSO
|
|
--------
|
|
lightning-cli(1), lightning-listconfigs(1), [writing plugins][writing plugins]
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Antoine Poinsot <<darosior@protonmail.com>> is mainly responsible.
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|
|
[writing plugins]: PLUGINS.md
|
|
[comment]: # ( SHA256STAMP:4ed30fb62c37111ea06b55d1252727c9c56fabd40e9e1f50083c99de74b8dfa1)
|