summaryrefslogtreecommitdiffstats
path: root/docs/man/borg-check.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/borg-check.1')
-rw-r--r--docs/man/borg-check.112
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1
index 386357f3b..6ea4d7175 100644
--- a/docs/man/borg-check.1
+++ b/docs/man/borg-check.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CHECK 1 "2021-03-22" "" "borg backup tool"
+.TH BORG-CHECK 1 "2021-07-12" "" "borg backup tool"
.SH NAME
borg-check \- Check repository consistency
.
@@ -40,6 +40,11 @@ The check command verifies the consistency of a repository and the corresponding
check \-\-repair is a potentially dangerous function and might lead to data loss
(for kinds of corruption it is not capable of dealing with). BE VERY CAREFUL!
.sp
+Pursuant to the previous warning it is also highly recommended to test the
+reliability of the hardware running this software with stress testing software
+such as memory testers. Unreliable hardware can also lead to data loss especially
+when this command is run in repair mode.
+.sp
First, the underlying repository data files are checked:
.INDENT 0.0
.IP \(bu 2
@@ -80,6 +85,11 @@ In repair mode, when all the archives were checked, orphaned chunks are deleted
from the repo. One cause of orphaned chunks are input file related errors (like
read errors) in the archive creation process.
.IP \(bu 2
+In verify\-data mode, a complete cryptographic verification of the archive data
+integrity is performed. This conflicts with \fB\-\-repository\-only\fP as this mode
+only makes sense if the archive checks are enabled. The full details of this mode
+are documented below.
+.IP \(bu 2
If checking a remote repo via \fBssh:\fP, the archive check is executed on the
client machine because it requires decryption, and this is always done client\-side
as key access is needed.