forked from TrueCloudLab/restic
120 lines
2.6 KiB
Groff
120 lines
2.6 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\-\-check\-unused\fP[=false]
|
|
find unused blobs
|
|
|
|
.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 subset n of m data packs (format: \fB\fCn/m\fR)
|
|
|
|
.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\-\-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 repo, this allows some operations on read\-only repos
|
|
|
|
.PP
|
|
\fB\-o\fP, \fB\-\-option\fP=[]
|
|
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
|
|
|
|
.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\-\-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 \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|