restic/doc/man/restic-restore.1

.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic 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 snapshotID "latest" can be used to restore the latest snapshot in the
repository.

.PP
To only restore a specific subfolder, you can use the "snapshotID:subfolder"
syntax, where "subfolder" is a path within the snapshot.


.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was any error.
Exit status is 10 if the repository does not exist.
Exit status is 11 if the repository is already locked.


.SH OPTIONS
.PP
\fB--delete\fP[=false]
	delete files from target directory if they do not exist in snapshot. Use '--dry-run -vv' to check what would be deleted

.PP
\fB--dry-run\fP[=false]
	do not write any data, just show what would be done

.PP
\fB-e\fP, \fB--exclude\fP=[]
	exclude a \fBpattern\fR (can be specified multiple times)

.PP
\fB--exclude-file\fP=[]
	read exclude patterns from a \fBfile\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 \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) (default: $RESTIC_HOST)

.PP
\fB--iexclude\fP=[]
	same as --exclude \fBpattern\fR but ignores the casing of filenames

.PP
\fB--iexclude-file\fP=[]
	same as --exclude-file but ignores casing of \fBfile\fRnames in patterns

.PP
\fB--iinclude\fP=[]
	same as --include \fBpattern\fR but ignores the casing of filenames

.PP
\fB--iinclude-file\fP=[]
	same as --include-file but ignores casing of \fBfile\fRnames in patterns

.PP
\fB-i\fP, \fB--include\fP=[]
	include a \fBpattern\fR (can be specified multiple times)

.PP
\fB--include-file\fP=[]
	read include patterns from a \fBfile\fR (can be specified multiple times)

.PP
\fB--overwrite\fP=always
	overwrite behavior, one of (always|if-changed|if-newer|never) (default: always)

.PP
\fB--path\fP=[]
	only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times, snapshots must include all specified paths)

.PP
\fB--sparse\fP[=false]
	restore files as sparse

.PP
\fB--tag\fP=[]
	only consider snapshots including \fBtag[,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=[]
	\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--http-user-agent\fP=""
	set a http user agent for outgoing http requests

.PP
\fB--insecure-no-password\fP[=false]
	use an empty password for the repository, must be passed to every restic command (insecure)

.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(1)\fP