diff --git a/src/borg/archiver/check_cmd.py b/src/borg/archiver/check_cmd.py index 7fe962bff..a5b5bf09f 100644 --- a/src/borg/archiver/check_cmd.py +++ b/src/borg/archiver/check_cmd.py @@ -85,12 +85,14 @@ class CheckMixIn: archive data (requires ``--verify-data``). This includes ensuring that the repository manifest exists, the archive metadata chunk is present, and that all chunks referencing files (items) in the archive exist. This requires - reading archive and file metadata, but not data. To cryptographically verify - the file (content) data integrity pass ``--verify-data``, but keep in mind - that this requires reading all data and is hence very time consuming. When - checking archives of a remote repository, archive checks run on the client - machine because they require decrypting data and therefore the encryption - key. + reading archive and file metadata, but not data. To scan for archives whose + entries were lost from the archive directory, pass ``--find-lost-archives``. + It requires reading all data and is hence very time consuming. + To additionally cryptographically verify the file (content) data integrity, + pass ``--verify-data``, which is even more time consuming. + + When checking archives of a remote repository, archive checks run on the client + machine because they require decrypting data and therefore the encryption key. Both steps can also be run independently. Pass ``--repository-only`` to run the repository checks only, or pass ``--archives-only`` to run the archive checks @@ -122,6 +124,15 @@ class CheckMixIn: encrypted repositories against attackers without access to the keys. You can not use ``--verify-data`` with ``--repository-only``. + The ``--find-lost-archives`` option will also scan the whole repository, but + tells Borg to search for lost archive metadata. If Borg encounters any archive + metadata that doesn't match with an archive directory entry, it means that an + entry was lost. + Unless ``borg compact`` is called, these archives can be fully restored with + ``--repair``. Please note that ``--find-lost-archives`` must read a lot of + data from the repository and is thus very time consuming. You can not use + ``--find-lost-archives`` with ``--repository-only``. + About repair mode +++++++++++++++++ @@ -180,12 +191,9 @@ class CheckMixIn: Consequently, if lost chunks were repaired earlier, it is advised to run ``--repair`` a second time after creating some new backups. - If ``--repair --find-lost-archives`` is given, Borg will scan the repository - for archive metadata and if it finds some where no corresponding archives - directory entry exists, it will create one. - This will make archives reappear for which the directory entry was lost. - This is only possible before ``borg compact`` would remove the archives' - data completely. + If ``--repair --find-lost-archives`` is given, previously lost entries will + be recreated in the archive directory. This is only possible before + ``borg compact`` would remove the archives' data completely. """ ) subparser = subparsers.add_parser(