restic/doc/man/restic-copy.1

184 lines
5.1 KiB
Groff
Raw Normal View History

2020-09-19 15:38:26 +00:00
.nh
2023-10-24 18:02:55 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
2020-09-19 15:38:26 +00:00
.SH NAME
.PP
2022-08-25 17:55:00 +00:00
restic-copy - Copy snapshots from one repository to another
2020-09-19 15:38:26 +00:00
.SH SYNOPSIS
.PP
\fBrestic copy [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
2021-02-14 10:44:20 +00:00
The "copy" command copies one or more snapshots from one repository to another.
.PP
NOTE: This process will have to both download (read) and upload (write) the
entire snapshot(s) due to the different encryption keys used in the source and
destination repositories. This /may incur higher bandwidth usage and costs/ than
expected during normal backup runs.
.PP
2022-08-25 17:55:00 +00:00
NOTE: The copying process does not re-chunk files, which may break deduplication
2021-02-14 10:44:20 +00:00
between the files copied and files already stored in the destination repository.
This means that copied files, which existed in both the source and destination
repository, /may occupy up to twice their space/ in the destination repository.
2022-08-25 17:55:00 +00:00
This can be mitigated by the "--copy-chunker-params" option when initializing a
2021-02-14 10:44:20 +00:00
new destination repository using the "init" command.
2020-09-19 15:38:26 +00:00
2024-07-26 09:30:37 +00:00
.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.
2020-09-19 15:38:26 +00:00
.SH OPTIONS
2024-07-26 09:30:37 +00:00
.PP
\fB--from-insecure-no-password\fP[=false]
use an empty password for the source repository, must be passed to every restic command (insecure)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--from-key-hint\fP=""
key ID of key to try decrypting the source repository first (default: $RESTIC_FROM_KEY_HINT)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--from-password-command\fP=""
2023-10-24 18:02:55 +00:00
shell \fBcommand\fR to obtain the source repository password from (default: $RESTIC_FROM_PASSWORD_COMMAND)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--from-password-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR to read the source repository password from (default: $RESTIC_FROM_PASSWORD_FILE)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--from-repo\fP=""
2023-10-24 18:02:55 +00:00
source \fBrepository\fR to copy snapshots from (default: $RESTIC_FROM_REPOSITORY)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--from-repository-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR from which to read the source repository location to copy snapshots from (default: $RESTIC_FROM_REPOSITORY_FILE)
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-h\fP, \fB--help\fP[=false]
help for copy
2020-09-19 15:38:26 +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 (can be specified multiple times) (default: $RESTIC_HOST)
2021-08-03 09:45:36 +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 (can be specified multiple times, snapshots must include all specified paths)
2020-09-19 15:38:26 +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 (can be specified multiple times)
2020-09-19 15:38:26 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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
2020-09-19 15:38:26 +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-08-25 17:55:00 +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)
2022-08-25 17:55:00 +00:00
.PP
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
2022-03-26 19:09:59 +00:00
2020-09-19 15:38:26 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--json\fP[=false]
2021-08-03 09:45:36 +00:00
set output mode to JSON for commands that support it
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +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)
2020-09-19 15:38:26 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP