Skip to content

Commit

Permalink
docs: Add doc for verifybackup rpc command.
Browse files Browse the repository at this point in the history
  • Loading branch information
Aditya Sharma authored and Aditya Sharma committed Oct 14, 2023
1 parent 58e99bf commit 7e529eb
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
46 changes: 46 additions & 0 deletions doc/lightning-verifybackup.7.md
Original file line number Diff line number Diff line change
@@ -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 <<[email protected]>> is mainly responsible.

SEE ALSO
--------

lightning-getsharedsecret(7)

RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

[comment]: # ( SHA256STAMP:9cfaa9eb4609b36accc3e3b12a352c00ddd402307e4461f4df274146d12f6eb0)

0 comments on commit 7e529eb

Please sign in to comment.