1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-22 15:57:07 +00:00
restic/doc/man/restic-restore.1

211 lines
5.2 KiB
Groff
Raw Normal View History

2017-08-05 09:42:37 +00:00
.nh
2023-10-24 18:02:55 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
2022-08-25 17:55:00 +00:00
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
2023-10-24 18:02:55 +00:00
The special snapshotID "latest" can be used to restore the latest snapshot in the
2017-08-05 09:42:37 +00:00
repository.
2023-10-24 18:02:55 +00:00
.PP
2024-07-26 09:30:37 +00:00
To only restore a specific subfolder, you can use the "snapshotID:subfolder"
2023-10-24 18:02:55 +00:00
syntax, where "subfolder" is a path within the snapshot.
2017-08-05 09:42:37 +00:00
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
2024-07-26 09:30:37 +00:00
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.
2020-09-19 15:38:26 +00:00
2017-08-05 09:42:37 +00:00
.SH OPTIONS
2024-07-26 09:30:37 +00:00
.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
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-e\fP, \fB--exclude\fP=[]
2023-10-24 18:02:55 +00:00
exclude a \fBpattern\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2024-07-26 09:30:37 +00:00
.PP
\fB--exclude-file\fP=[]
read exclude patterns from a \fBfile\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-h\fP, \fB--help\fP[=false]
2021-08-03 09:45:36 +00:00
help for restore
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-H\fP, \fB--host\fP=[]
2024-07-26 09:30:37 +00:00
only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) (default: $RESTIC_HOST)
2017-08-05 09:42:37 +00:00
2019-04-23 11:19:39 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--iexclude\fP=[]
2024-07-26 09:30:37 +00:00
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
2019-04-23 11:19:39 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--iinclude\fP=[]
2024-07-26 09:30:37 +00:00
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
2019-04-23 11:19:39 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-i\fP, \fB--include\fP=[]
2024-07-26 09:30:37 +00:00
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)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--path\fP=[]
2024-07-26 09:30:37 +00:00
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)
2023-01-12 19:51:19 +00:00
.PP
\fB--sparse\fP[=false]
restore files as sparse
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tag\fP=[]
2023-10-24 18:02:55 +00:00
only consider snapshots including \fBtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-t\fP, \fB--target\fP=""
2021-08-03 09:45:36 +00:00
directory to extract data to
2017-08-05 09:42:37 +00:00
2018-08-06 19:28:59 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--verify\fP[=false]
2021-08-03 09:45:36 +00:00
verify restored files content
2018-08-06 19:28:59 +00:00
2017-08-05 09:42:37 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cacert\fP=[]
2023-10-24 18:02:55 +00:00
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cache-dir\fP=""
2023-10-24 18:02:55 +00:00
set the cache \fBdirectory\fR\&. (default: use system default cache directory)
2017-09-24 21:13:04 +00:00
2017-12-27 21:31:03 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cleanup-cache\fP[=false]
2021-08-03 09:45:36 +00:00
auto remove old cache directories
2017-12-27 21:31:03 +00:00
2022-03-26 19:09:59 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--compression\fP=auto
2023-07-31 18:23:24 +00:00
compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
2022-03-26 19:09:59 +00:00
2024-07-26 09:30:37 +00:00
.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)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
2021-08-03 09:45:36 +00:00
set output mode to JSON for commands that support it
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--key-hint\fP=""
2023-10-24 18:02:55 +00:00
\fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
2019-01-06 20:40:32 +00:00
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--limit-download\fP=0
2023-10-24 18:02:55 +00:00
limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--limit-upload\fP=0
2023-10-24 18:02:55 +00:00
limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--no-cache\fP[=false]
2021-08-03 09:45:36 +00:00
do not use a local cache
2017-09-24 21:13:04 +00:00
2024-02-04 18:50:51 +00:00
.PP
\fB--no-extra-verify\fP[=false]
skip additional verification of data before upload (see documentation)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-o\fP, \fB--option\fP=[]
2023-10-24 18:02:55 +00:00
set extended option (\fBkey=value\fR, can be specified multiple times)
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--pack-size\fP=0
2023-10-24 18:02:55 +00:00
set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
2022-08-25 17:55:00 +00:00
.PP
\fB--password-command\fP=""
2023-10-24 18:02:55 +00:00
shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
2019-01-06 20:40:32 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-p\fP, \fB--password-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-q\fP, \fB--quiet\fP[=false]
2021-08-03 09:45:36 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-r\fP, \fB--repo\fP=""
2023-10-24 18:02:55 +00:00
\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
2020-11-05 08:41:35 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--repository-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
2017-08-05 09:42:37 +00:00
2023-07-31 18:23:24 +00:00
.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)
2018-02-17 19:27:28 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tls-client-cert\fP=""
2023-10-24 18:02:55 +00:00
path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
2018-02-17 19:27:28 +00:00
2018-05-21 13:57:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-v\fP, \fB--verbose\fP[=0]
2023-04-24 18:28:37 +00:00
be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP