restic/doc/man/restic-check.1

128 lines
3.0 KiB
Groff
Raw Normal View History

2017-08-05 09:42:37 +00:00
.nh
2021-08-03 09:45:36 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
restic\-check \- Check the repository for errors
2017-08-05 09:42:37 +00:00
.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.
2017-09-24 21:13:04 +00:00
.PP
By default, the "check" command will always load all data directly from the
repository and not use a local cache.
2017-08-05 09:42:37 +00:00
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
2017-08-05 09:42:37 +00:00
.SH OPTIONS
.PP
\fB\-\-check\-unused\fP[=false]
2021-08-03 09:45:36 +00:00
find unused blobs
2017-08-05 09:42:37 +00:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2021-08-03 09:45:36 +00:00
help for check
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-read\-data\fP[=false]
2021-08-03 09:45:36 +00:00
read all data blobs
2017-08-05 09:42:37 +00:00
2018-02-26 20:32:16 +00:00
.PP
\fB\-\-read\-data\-subset\fP=""
2022-03-26 19:09:59 +00:00
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
2018-02-26 20:32:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-with\-cache\fP[=false]
2021-08-03 09:45:36 +00:00
use the cache
2017-09-24 21:13:04 +00:00
2017-08-05 09:42:37 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-cacert\fP=[]
2021-08-03 09:45:36 +00:00
\fB\fCfile\fR to load root certificates from (default: use system certificates)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-cache\-dir\fP=""
2021-08-03 09:45:36 +00:00
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
2017-09-24 21:13:04 +00:00
2017-12-27 21:31:03 +00:00
.PP
\fB\-\-cleanup\-cache\fP[=false]
2021-08-03 09:45:36 +00:00
auto remove old cache directories
2017-12-27 21:31:03 +00:00
2022-03-26 19:09:59 +00:00
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-json\fP[=false]
2021-08-03 09:45:36 +00:00
set output mode to JSON for commands that support it
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2019-01-06 20:40:32 +00:00
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-limit\-download\fP=0
2021-08-03 09:45:36 +00:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-limit\-upload\fP=0
2021-08-03 09:45:36 +00:00
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
2021-08-03 09:45:36 +00:00
do not use a local cache
2017-09-24 21:13:04 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
2021-08-03 09:45:36 +00:00
do not lock the repository, this allows some operations on read\-only repositories
2017-08-05 09:42:37 +00:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2021-08-03 09:45:36 +00:00
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
2021-08-03 09:45:36 +00:00
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
2019-01-06 20:40:32 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
2017-08-05 09:42:37 +00:00
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
2021-08-03 09:45:36 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
2020-11-05 08:41:35 +00:00
.PP
\fB\-\-repository\-file\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE)
2017-08-05 09:42:37 +00:00
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2021-08-03 09:45:36 +00:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
2018-02-17 19:27:28 +00:00
2018-05-21 13:57:32 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
2021-08-03 09:45:36 +00:00
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP