2
2
mirror of https://github.com/octoleo/restic.git synced 2024-11-16 01:57:10 +00:00
restic/doc/man/restic-repair-snapshots.1
2024-02-04 19:50:51 +01:00

162 lines
4.1 KiB
Groff

.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-repair-snapshots - Repair snapshots
.SH SYNOPSIS
.PP
\fBrestic repair snapshots [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION
.PP
The "repair snapshots" command repairs broken snapshots. It scans the given
snapshots and generates new ones with damaged directories and file contents
removed. If the broken snapshots are deleted, a prune run will be able to
clean up the repository.
.PP
The command depends on a correct index, thus make sure to run "repair index"
first!
.SH WARNING
.PP
Repairing and deleting broken snapshots causes data loss! It will remove broken
directories and modify broken files in the modified snapshots.
.PP
If the contents of directories and files are still available, the better option
is to run "backup" which in that case is able to heal existing snapshots. Only
use the "repair snapshots" command if you need to recover an old and broken
snapshot!
.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-n\fP, \fB--dry-run\fP[=false]
do not do anything, just print what would be done
.PP
\fB--forget\fP[=false]
remove original snapshots after creating new ones
.PP
\fB-h\fP, \fB--help\fP[=false]
help for snapshots
.PP
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fBhost\fR (can be specified multiple times)
.PP
\fB--path\fP=[]
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times)
.PP
\fB--tag\fP=[]
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\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|max) (default: $RESTIC_COMPRESSION)
.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--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
.PP
\fBrestic-repair(1)\fP