added documentation of command stop

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
This commit is contained in:
Vincenzo Palazzo 2020-08-16 15:14:52 +02:00 committed by Rusty Russell
parent d477a8d755
commit 5b1e181525
2 changed files with 46 additions and 0 deletions

View file

@ -70,6 +70,7 @@ c-lightning Documentation
lightning-setchannelfee <lightning-setchannelfee.7.md>
lightning-signmessage <lightning-signmessage.7.md>
lightning-signpsbt <lightning-signpsbt.7.md>
lightning-stop <lightning-stop.7.md>
lightning-txdiscard <lightning-txdiscard.7.md>
lightning-txprepare <lightning-txprepare.7.md>
lightning-txsend <lightning-txsend.7.md>

45
doc/lightning-stop.7.md Normal file
View file

@ -0,0 +1,45 @@
lightning-stop -- Command to shut off c-lightning node.
============================================================
SYNOPSIS
--------
**stop**
DESCRIPTION
-----------
The **stop** is a RPC to shut off the c-lightning node.
EXAMPLE JSON REQUEST
------------
```json
{
"id": 82,
"method": "stop",
"params": {}
}
```
RETURN VALUE
------------
On success, the command will return a emptu object.
EXAMPLE JSON RESPONSE
-----
```json
{}
```
AUTHOR
------
Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>