mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-25 01:06:50 +00:00
180 lines
6.8 KiB
Groff
180 lines
6.8 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.TH "BORG-CHECK" 1 "2023-06-11" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-check \- Check repository consistency
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] check [options]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
The check command verifies the consistency of a repository and the corresponding archives.
|
|
.sp
|
|
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
|
|
For all segments, the segment magic header is checked.
|
|
.IP \(bu 2
|
|
For all objects stored in the segments, all metadata (e.g. CRC and size) and
|
|
all data is read. The read data is checked by size and CRC. Bit rot and other
|
|
types of accidental damage can be detected this way.
|
|
.IP \(bu 2
|
|
In repair mode, if an integrity error is detected in a segment, try to recover
|
|
as many objects from the segment as possible.
|
|
.IP \(bu 2
|
|
In repair mode, make sure that the index is consistent with the data stored in
|
|
the segments.
|
|
.IP \(bu 2
|
|
If checking a remote repo via \fBssh:\fP, the repo check is executed on the server
|
|
without causing significant network traffic.
|
|
.IP \(bu 2
|
|
The repository check can be skipped using the \fB\-\-archives\-only\fP option.
|
|
.IP \(bu 2
|
|
A repository check can be time consuming. Partial checks are possible with the
|
|
\fB\-\-max\-duration\fP option.
|
|
.UNINDENT
|
|
.sp
|
|
Second, the consistency and correctness of the archive metadata is verified:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
Is the repo manifest present? If not, it is rebuilt from archive metadata
|
|
chunks (this requires reading and decrypting of all metadata and data).
|
|
.IP \(bu 2
|
|
Check if archive metadata chunk is present; if not, remove archive from manifest.
|
|
.IP \(bu 2
|
|
For all files (items) in the archive, for all chunks referenced by these
|
|
files, check if chunk is present. In repair mode, if a chunk is not present,
|
|
replace it with a same\-size replacement chunk of zeroes. If a previously lost
|
|
chunk reappears (e.g. via a later backup), in repair mode the all\-zero replacement
|
|
chunk will be replaced by the correct chunk. This requires reading of archive and
|
|
file metadata, but not data.
|
|
.IP \(bu 2
|
|
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.
|
|
.IP \(bu 2
|
|
The archive checks can be time consuming; they can be skipped using the
|
|
\fB\-\-repository\-only\fP option.
|
|
.UNINDENT
|
|
.sp
|
|
The \fB\-\-max\-duration\fP option can be used to split a long\-running repository check
|
|
into multiple partial checks. After the given number of seconds the check is
|
|
interrupted. The next partial check will continue where the previous one stopped,
|
|
until the complete repository has been checked. Example: Assuming a complete check took 7
|
|
hours, then running a daily check with \-\-max\-duration=3600 (1 hour) resulted in one
|
|
completed check per week.
|
|
.sp
|
|
Attention: A partial \-\-repository\-only check can only do way less checking than a full
|
|
\-\-repository\-only check: only the non\-cryptographic checksum checks on segment file
|
|
entries are done, while a full \-\-repository\-only check would also do a repo index check.
|
|
A partial check cannot be combined with the \fB\-\-repair\fP option. Partial checks
|
|
may therefore be useful only with very large repositories where a full check would take
|
|
too long.
|
|
Doing a full repository check aborts a partial check; the next partial check will restart
|
|
from the beginning.
|
|
.sp
|
|
The \fB\-\-verify\-data\fP option will perform a full integrity verification (as opposed to
|
|
checking the CRC32 of the segment) of data, which means reading the data from the
|
|
repository, decrypting and decompressing it. This is a cryptographic verification,
|
|
which will detect (accidental) corruption. For encrypted repositories it is
|
|
tamper\-resistant as well, unless the attacker has access to the keys. It is also very
|
|
slow.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-repository\-only
|
|
only perform repository checks
|
|
.TP
|
|
.B \-\-archives\-only
|
|
only perform archives checks
|
|
.TP
|
|
.B \-\-verify\-data
|
|
perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP)
|
|
.TP
|
|
.B \-\-repair
|
|
attempt to repair any inconsistencies found
|
|
.TP
|
|
.BI \-\-max\-duration \ SECONDS
|
|
do only a partial repo check for max. SECONDS seconds (Default: unlimited)
|
|
.UNINDENT
|
|
.SS Archive filters
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
|
|
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq.
|
|
.TP
|
|
.BI \-\-sort\-by \ KEYS
|
|
Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
|
|
.TP
|
|
.BI \-\-first \ N
|
|
consider first N archives after other filters were applied
|
|
.TP
|
|
.BI \-\-last \ N
|
|
consider last N archives after other filters were applied
|
|
.TP
|
|
.BI \-\-oldest \ TIMESPAN
|
|
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
|
|
.TP
|
|
.BI \-\-newest \ TIMESPAN
|
|
consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g. 7d or 12m.
|
|
.TP
|
|
.BI \-\-older \ TIMESPAN
|
|
consider archives older than (now \- TIMESPAN), e.g. 7d oder 12m.
|
|
.TP
|
|
.BI \-\-newer \ TIMESPAN
|
|
consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|