mirror of
https://github.com/octoleo/restic.git
synced 2024-11-30 00:33:57 +00:00
132 lines
3.1 KiB
Groff
132 lines
3.1 KiB
Groff
.nh
|
|
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
restic-check - Check the repository for errors
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBrestic check [flags]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The "check" command tests the repository for errors and reports any errors it
|
|
finds. It can also be used to read all data and therefore simulate a restore.
|
|
|
|
.PP
|
|
By default, the "check" command will always load all data directly from the
|
|
repository and not use a local cache.
|
|
|
|
|
|
.SH EXIT STATUS
|
|
.PP
|
|
Exit status is 0 if the command was successful, and non-zero if there was any error.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for check
|
|
|
|
.PP
|
|
\fB--read-data\fP[=false]
|
|
read all data blobs
|
|
|
|
.PP
|
|
\fB--read-data-subset\fP=""
|
|
read a \fB\fCsubset\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--with-cache\fP[=false]
|
|
use the cache
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB--cacert\fP=[]
|
|
\fB\fCfile\fR to load root certificates from (default: use system certificates)
|
|
|
|
.PP
|
|
\fB--cache-dir\fP=""
|
|
set the cache \fB\fCdirectory\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|max)
|
|
|
|
.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=""
|
|
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
|
|
|
|
.PP
|
|
\fB--limit-download\fP=0
|
|
limits downloads to a maximum rate in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--limit-upload\fP=0
|
|
limits uploads to a maximum rate in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--no-cache\fP[=false]
|
|
do not use a local cache
|
|
|
|
.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 (\fB\fCkey=value\fR, can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--pack-size\fP=0
|
|
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
|
|
|
|
.PP
|
|
\fB--password-command\fP=""
|
|
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
|
|
|
|
.PP
|
|
\fB-p\fP, \fB--password-file\fP=""
|
|
\fB\fCfile\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=""
|
|
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
|
|
|
|
.PP
|
|
\fB--repository-file\fP=""
|
|
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
|
|
|
|
.PP
|
|
\fB--tls-client-cert\fP=""
|
|
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
|
|
|
|
.PP
|
|
\fB-v\fP, \fB--verbose\fP[=0]
|
|
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|