diff --git a/doc/Makefile b/doc/Makefile index 8251ea44ca26..38283b394a1c 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -110,6 +110,7 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightning-txsend.7 \ doc/lightning-unreserveinputs.7 \ doc/lightning-utxopsbt.7 \ + doc/lightning-verifybackup.7 \ doc/lightning-wait.7 \ doc/lightning-waitinvoice.7 \ doc/lightning-waitanyinvoice.7 \ diff --git a/doc/lightning-verifybackup.7.md b/doc/lightning-verifybackup.7.md new file mode 100644 index 000000000000..7bf0a73a742d --- /dev/null +++ b/doc/lightning-verifybackup.7.md @@ -0,0 +1,46 @@ +lightning-verifybackup -- Command for verifying the status of backup in emergency.recover and peer_storage +========================================================================================================================= + +SYNOPSIS +-------- + +**verifybackup** + +DESCRIPTION +----------- + +The **verifybackup** RPC command fetches data from the emergency.recover +file and tries to decrypt it. It also watches out for the latest peer_storage +that we have in our datastore. + +This would help users to detect if there is any discrepancy in the backup that +is stored in the file or peer_storage. They can use this as a precautionary check, +if anything goes wrong users and delete the emergency.recover so that node +can build a new one upon restart. + +RETURN VALUE +------------ + +On success, an object is returned, containing: +- **emergency.recover**: + - True, if everything is fine, otherwise the reason filled in as a string. +- **peer_storage**: + - True, if the backup is fine, otherwise the reason filled in as a string. + + +AUTHOR +------ + +Aditya <> is mainly responsible. + +SEE ALSO +-------- + +lightning-getsharedsecret(7) + +RESOURCES +--------- + +Main web site: + +[comment]: # ( SHA256STAMP:9cfaa9eb4609b36accc3e3b12a352c00ddd402307e4461f4df274146d12f6eb0) \ No newline at end of file