mirror of https://github.com/borgbackup/borg.git
149 lines
4.7 KiB
Groff
149 lines
4.7 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH BORG-CHECK 1 "2017-06-18" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-check \- Check repository consistency
|
|
.
|
|
.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
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] check <options> REPOSITORY_OR_ARCHIVE
|
|
.SH DESCRIPTION
|
|
.sp
|
|
The check command verifies the consistency of a repository and the corresponding archives.
|
|
.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
|
|
If we are in repair mode and a integrity error is detected for a segment,
|
|
we try to recover as many objects from the segment as possible.
|
|
.IP \(bu 2
|
|
In repair mode, it makes sure that the index is consistent with the data
|
|
stored in the segments.
|
|
.IP \(bu 2
|
|
If you use a remote repo server via ssh:, the repo check is executed on the
|
|
repo server without causing significant network traffic.
|
|
.IP \(bu 2
|
|
The repository check can be skipped using the \fB\-\-archives\-only\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.
|
|
If a chunk is not present and we are in repair mode, replace it with a same\-size
|
|
replacement chunk of zeros.
|
|
If a previously lost chunk reappears (e.g. via a later backup) and we are 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
|
|
If we are in repair mode and we checked all the archives: delete orphaned
|
|
chunks from the repo.
|
|
.IP \(bu 2
|
|
if you use a remote repo server via ssh:, the archive check is executed on
|
|
the client machine (because if encryption is enabled, the checks will require
|
|
decryption and this is always done client\-side, because key access will be
|
|
required).
|
|
.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\-\-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.
|
|
.sp
|
|
It is also very slow.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B REPOSITORY_OR_ARCHIVE
|
|
repository or archive to check consistency of
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.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
|
|
.B \-\-save\-space
|
|
work slower, but using less space
|
|
.UNINDENT
|
|
.SS filters
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-P\fP,\fB \-\-prefix
|
|
only consider archive names starting with this prefix.
|
|
.TP
|
|
.B \-a\fP,\fB \-\-glob\-archives
|
|
only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
|
|
.TP
|
|
.B \-\-sort\-by
|
|
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
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|