1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-24 08:44:52 +00:00
restic/doc/man/restic-restore.1
2023-04-24 20:28:37 +02:00

159 lines
3.7 KiB
Groff

.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
.SH NAME
.PP
restic-restore - Extract the data from a snapshot
.SH SYNOPSIS
.PP
\fBrestic restore [flags] snapshotID\fP
.SH DESCRIPTION
.PP
The "restore" command extracts the data from a snapshot from the repository to
a directory.
.PP
The special snapshot "latest" can be used to restore the latest snapshot in the
repository.
.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-e\fP, \fB--exclude\fP=[]
exclude a \fB\fCpattern\fR (can be specified multiple times)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for restore
.PP
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB--iexclude\fP=[]
same as \fB\fC--exclude\fR but ignores the casing of filenames
.PP
\fB--iinclude\fP=[]
same as \fB\fC--include\fR but ignores the casing of filenames
.PP
\fB-i\fP, \fB--include\fP=[]
include a \fB\fCpattern\fR, exclude everything else (can be specified multiple times)
.PP
\fB--path\fP=[]
only consider snapshots including this (absolute) \fB\fCpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB--sparse\fP[=false]
restore files as sparse
.PP
\fB--tag\fP=[]
only consider snapshots including \fB\fCtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB-t\fP, \fB--target\fP=""
directory to extract data to
.PP
\fB--verify\fP[=false]
verify restored files content
.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 \fB\fCrate\fR in KiB/s. (default: unlimited)
.PP
\fB--limit-upload\fP=0
limits uploads to a maximum \fB\fCrate\fR 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 \fB\fCsize\fR 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=n``, max level/times is 2)
.SH SEE ALSO
.PP
\fBrestic(1)\fP