restic/doc/man/restic-restore.1

129 lines
2.8 KiB
Groff
Raw Normal View History

2017-09-26 11:16:08 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2017-08-05 09:42:37 +00:00
.nh
.ad l
.SH NAME
.PP
restic\-restore \- Extract the data from a snapshot
2017-08-05 09:42:37 +00:00
.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 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 host when the snapshot ID is "latest"
.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 which include this (absolute) \fB\fCpath\fR for snapshot ID "latest"
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest"
.PP
\fB\-t\fP, \fB\-\-target\fP=""
directory to extract data to
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-verify\fP[=false]
verify restored files content
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=[]
2018-05-21 13:57:32 +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=""
2018-10-13 11:48:30 +00:00
set the cache directory. (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]
auto remove old cache directories
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2017-11-26 18:46:16 +00:00
.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)
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
do not use a local cache
2017-08-05 09:42:37 +00:00
.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)
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND)
2017-08-05 09:42:37 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (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=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
2018-05-21 13:57:32 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR)
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP