core-lightning/doc/lightning-stop.7.md

lightning-stop -- Command to shutdown the Core Lightning node.
==============================================================

SYNOPSIS
--------

**stop**

DESCRIPTION
-----------

The **stop** is a RPC command to shut off the Core Lightning node.

EXAMPLE JSON REQUEST
------------
```json
{
  "id": 82,
  "method": "stop",
  "params": {}
}
```

RETURN VALUE
------------

[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, returns a single element (string) (always "Shutdown complete")
[comment]: # (GENERATE-FROM-SCHEMA-END)

Once it has returned, the daemon has cleaned up completely, and if
desired may be restarted immediately.


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>
[comment]: # ( SHA256STAMP:a83ac745b36e0e3d00ba11f036cec93973773f47e1265eb5c70a3d3298e58e4b)
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-04-06 07:09:48 +02:00			`lightning-stop -- Command to shutdown the Core Lightning node.`
docs: Fix manpage title It was causing the first sublevel of headings to be shown on RTD. Changelog-None 2022-06-08 16:47:55 +02:00			`==============================================================`
added documentation of command stop Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 2020-08-16 15:14:52 +02:00
			`SYNOPSIS`
			`--------`

			`stop`

			`DESCRIPTION`
			`-----------`

doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-04-06 07:09:48 +02:00			`The stop is a RPC command to shut off the Core Lightning node.`
added documentation of command stop Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 2020-08-16 15:14:52 +02:00
			`EXAMPLE JSON REQUEST`
			`------------`
			```json
			`{`
			`"id": 82,`
			`"method": "stop",`
			`"params": {}`
			`}`
			```

			`RETURN VALUE`
			`------------`

doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite. 2021-06-16 03:10:17 +02:00			`[comment]: # (GENERATE-FROM-SCHEMA-START)`
			`On success, returns a single element (string) (always "Shutdown complete")`
			`[comment]: # (GENERATE-FROM-SCHEMA-END)`

			`Once it has returned, the daemon has cleaned up completely, and if`
			`desired may be restarted immediately.`
added documentation of command stop Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 2020-08-16 15:14:52 +02:00

			`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>`
make-schema: don't include tools/fromschema.py in SHASUMS We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables 2022-07-13 17:45:39 +02:00			`[comment]: # ( SHA256STAMP:a83ac745b36e0e3d00ba11f036cec93973773f47e1265eb5c70a3d3298e58e4b)`