mirror of
https://github.com/restic/restic.git
synced 2026-06-10 10:59:43 +00:00
Alexander Neumann
166 lines
4.4 KiB
Groff
166 lines
4.4 KiB
Groff
.nh
|
|
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
|
|
|
|
.SH NAME
|
|
restic-check - Check the repository for errors
|
|
|
|
|
|
.SH SYNOPSIS
|
|
\fBrestic check [flags]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
The "check" command tests the repository for errors and reports any errors it
|
|
finds.
|
|
|
|
.PP
|
|
By default, check verifies the structural consistency and integrity of
|
|
snapshots, trees and pack files. To also verify the integrity of the actual
|
|
backed-up data, use the --read-data or --read-data-subset flags.
|
|
|
|
.PP
|
|
By default, check creates a new temporary cache directory to verify data.
|
|
To reuse the existing cache, use the --with-cache flag.
|
|
|
|
|
|
.SH EXIT STATUS
|
|
Exit status is 0 if the command was successful.
|
|
Exit status is 1 if there was any error.
|
|
Exit status is 10 if the repository does not exist.
|
|
Exit status is 11 if the repository is already locked.
|
|
Exit status is 12 if the password is incorrect.
|
|
|
|
|
|
.SH OPTIONS
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for check
|
|
|
|
.PP
|
|
\fB-H\fP, \fB--host\fP=[]
|
|
only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST)
|
|
|
|
.PP
|
|
\fB--path\fP=[]
|
|
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths)
|
|
|
|
.PP
|
|
\fB--read-data\fP[=false]
|
|
read all data blobs
|
|
|
|
.PP
|
|
\fB--read-data-subset\fP=""
|
|
read a \fBsubset\fR of data packs, specified as 'n/t' for specific part, or either 'x%' or 'x.y%' or a size in bytes with suffixes k/K, m/M, g/G, t/T for a random subset
|
|
|
|
.PP
|
|
\fB--tag\fP=[]
|
|
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--with-cache\fP[=false]
|
|
use existing cache, only read uncached data from repository
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
\fB--cacert\fP=[]
|
|
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
|
|
|
|
.PP
|
|
\fB--cache-dir\fP=""
|
|
set the cache \fBdirectory\fR\&. (default: use system default cache directory)
|
|
|
|
.PP
|
|
\fB--cleanup-cache\fP[=false]
|
|
auto remove old cache directories
|
|
|
|
.PP
|
|
\fB--compression\fP=auto
|
|
compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION)
|
|
|
|
.PP
|
|
\fB--http-user-agent\fP=""
|
|
set a http user agent for outgoing http requests
|
|
|
|
.PP
|
|
\fB--insecure-no-password\fP[=false]
|
|
use an empty password for the repository, must be passed to every restic command (insecure)
|
|
|
|
.PP
|
|
\fB--insecure-tls\fP[=false]
|
|
skip TLS certificate verification when connecting to the repository (insecure)
|
|
|
|
.PP
|
|
\fB--json\fP[=false]
|
|
set output mode to JSON for commands that support it
|
|
|
|
.PP
|
|
\fB--key-hint\fP=""
|
|
\fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
|
|
|
|
.PP
|
|
\fB--limit-download\fP=0
|
|
limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--limit-upload\fP=0
|
|
limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--no-cache\fP[=false]
|
|
do not use a local cache
|
|
|
|
.PP
|
|
\fB--no-extra-verify\fP[=false]
|
|
skip additional verification of data before upload (see documentation)
|
|
|
|
.PP
|
|
\fB--no-lock\fP[=false]
|
|
do not lock the repository, this allows some operations on read-only repositories
|
|
|
|
.PP
|
|
\fB-o\fP, \fB--option\fP=[]
|
|
set extended option (\fBkey=value\fR, can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--pack-size\fP=0
|
|
set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
|
|
|
|
.PP
|
|
\fB--password-command\fP=""
|
|
shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
|
|
|
|
.PP
|
|
\fB-p\fP, \fB--password-file\fP=""
|
|
\fBfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
|
|
|
|
.PP
|
|
\fB-q\fP, \fB--quiet\fP[=false]
|
|
do not output comprehensive progress report
|
|
|
|
.PP
|
|
\fB-r\fP, \fB--repo\fP=""
|
|
\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
|
|
|
|
.PP
|
|
\fB--repository-file\fP=""
|
|
\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
|
|
|
|
.PP
|
|
\fB--retry-lock\fP=0s
|
|
retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries)
|
|
|
|
.PP
|
|
\fB--stuck-request-timeout\fP=5m0s
|
|
\fBduration\fR after which to retry stuck requests
|
|
|
|
.PP
|
|
\fB--tls-client-cert\fP=""
|
|
path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
|
|
|
|
.PP
|
|
\fB-v\fP, \fB--verbose\fP[=0]
|
|
be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)
|
|
|
|
|
|
.SH SEE ALSO
|
|
\fBrestic(1)\fP
|