2
2
mirror of https://github.com/octoleo/restic.git synced 2024-12-23 19:38:57 +00:00
restic/doc/man/restic-copy.1

142 lines
3.9 KiB
Groff
Raw Normal View History

2020-11-05 08:41:35 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2020-09-19 15:38:26 +00:00
.nh
2020-11-05 08:41:35 +00:00
.ad l
2020-09-19 15:38:26 +00:00
.SH NAME
.PP
restic\-copy \- Copy snapshots from one repository to another
.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
NOTE: The copying process does not re\-chunk files, which may break deduplication
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.
This can be mitigated by the "\-\-copy\-chunker\-params" option when initializing a
new destination repository using the "init" command.
2020-09-19 15:38:26 +00:00
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2020-11-05 08:41:35 +00:00
help for copy
2020-09-19 15:38:26 +00:00
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-key\-hint2\fP=""
2020-11-05 08:41:35 +00:00
key ID of key to try decrypting the destination repository first (default: $RESTIC\_KEY\_HINT2)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-password\-command2\fP=""
2020-11-05 08:41:35 +00:00
shell \fB\fCcommand\fR to obtain the destination repository password from (default: $RESTIC\_PASSWORD\_COMMAND2)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-password\-file2\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCfile\fR to read the destination repository password from (default: $RESTIC\_PASSWORD\_FILE2)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-path\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot ID is given
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-repo2\fP=""
2020-11-05 08:41:35 +00:00
destination \fB\fCrepository\fR to copy snapshots to (default: $RESTIC\_REPOSITORY2)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-tag\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot ID is given
2020-09-19 15:38:26 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
2020-11-05 08:41:35 +00:00
\fB\fCfile\fR to load root certificates from (default: use system certificates)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-cache\-dir\fP=""
2020-11-05 08:41:35 +00:00
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-cleanup\-cache\fP[=false]
2020-11-05 08:41:35 +00:00
auto remove old cache directories
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-json\fP[=false]
2020-11-05 08:41:35 +00:00
set output mode to JSON for commands that support it
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-key\-hint\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-limit\-download\fP=0
2020-11-05 08:41:35 +00:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-limit\-upload\fP=0
2020-11-05 08:41:35 +00:00
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
2020-11-05 08:41:35 +00:00
do not use a local cache
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
2020-11-05 08:41:35 +00:00
do not lock the repository, this allows some operations on read\-only repositories
2020-09-19 15:38:26 +00:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2020-11-05 08:41:35 +00:00
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-password\-command\fP=""
2020-11-05 08:41:35 +00:00
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
2020-09-19 15:38:26 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
2020-09-19 15:38:26 +00:00
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
2020-11-05 08:41:35 +00:00
do not output comprehensive progress report
2020-09-19 15:38:26 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2020-11-05 08:41:35 +00:00
\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)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2020-11-05 08:41:35 +00:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
2020-09-19 15:38:26 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
2020-11-05 08:41:35 +00:00
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
2020-09-19 15:38:26 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP