diff --git a/doc/Makefile b/doc/Makefile index 8fc3d7db7eb9..9e6ce8cf4026 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -88,6 +88,7 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightning-plugin.7 \ doc/lightning-preapproveinvoice.7 \ doc/lightning-preapprovekeysend.7 \ + doc/lightning-recover.7 \ doc/lightning-recoverchannel.7 \ doc/lightning-renepay.7 \ doc/lightning-renepaystatus.7 \ diff --git a/doc/index.rst b/doc/index.rst index 373968528c5e..fd33b4beb22a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -100,6 +100,7 @@ Core Lightning Documentation lightning-plugin lightning-preapproveinvoice lightning-preapprovekeysend + lightning-recover lightning-recoverchannel lightning-renepay lightning-renepaystatus diff --git a/doc/lightning-recover.7.md b/doc/lightning-recover.7.md new file mode 100644 index 000000000000..cbb8c8309ece --- /dev/null +++ b/doc/lightning-recover.7.md @@ -0,0 +1,42 @@ +lightning-recover -- Reinitialize Your Node for Recovery +======================================================== + +SYNOPSIS +-------- + +**recover** *hsmsecret* + +DESCRIPTION +----------- + +The **recover** RPC command wipes your node and restarts it with +the `--recover` option. This is only permitted if the node is unused: +no channels, no bitcoin addresses issued (you can use `check` to see +if recovery is possible). + +*hsmsecret* is either a codex32 secret starting with "cl1" as returned +by `hsmtool getcodexsecret`, or a raw 64 character hex string. + +NOTE: this command only currently works with the `sqlite3` database backend. + +RETURN VALUE +------------ + +On success, an empty object is returned, and your node is restarted. + +AUTHOR +------ + +Rusty Russell <> is mainly responsible. + +SEE ALSO +-------- + +lightning-hsmtool(7) + +RESOURCES +--------- + +Main web site: + +[comment]: # ( SHA256STAMP:9cfaa9eb4609b36accc3e3b12a352c00ddd402307e4461f4df274146d12f6eb0)