mirror of
https://github.com/octoleo/restic.git
synced 2024-12-30 21:41:54 +00:00
130 lines
3.2 KiB
Groff
130 lines
3.2 KiB
Groff
.nh
|
|
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
restic\-dump \- Print a backed\-up file to stdout
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBrestic dump [flags] snapshotID file\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The "dump" command extracts files from a snapshot from the repository. If a
|
|
single file is selected, it prints its contents to stdout. Folders are output
|
|
as a tar (default) or zip file containing the contents of the specified folder.
|
|
Pass "/" as file name to dump the whole snapshot as an archive file.
|
|
|
|
.PP
|
|
The special snapshot "latest" can be used to use the latest snapshot in the
|
|
repository.
|
|
|
|
|
|
.SH EXIT STATUS
|
|
.PP
|
|
Exit status is 0 if the command was successful, and non\-zero if there was any error.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB\-a\fP, \fB\-\-archive\fP="tar"
|
|
set archive \fB\fCformat\fR as "tar" or "zip"
|
|
|
|
.PP
|
|
\fB\-h\fP, \fB\-\-help\fP[=false]
|
|
help for dump
|
|
|
|
.PP
|
|
\fB\-H\fP, \fB\-\-host\fP=[]
|
|
only consider snapshots for this host when the snapshot ID is "latest" (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"
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB\-\-cacert\fP=[]
|
|
\fB\fCfile\fR to load root certificates from (default: use system certificates)
|
|
|
|
.PP
|
|
\fB\-\-cache\-dir\fP=""
|
|
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
|
|
|
|
.PP
|
|
\fB\-\-cleanup\-cache\fP[=false]
|
|
auto remove old cache directories
|
|
|
|
.PP
|
|
\fB\-\-insecure\-tls\fP[=false]
|
|
skip TLS certificate verification when connecting to the repo (insecure)
|
|
|
|
.PP
|
|
\fB\-\-json\fP[=false]
|
|
set output mode to JSON for commands that support it
|
|
|
|
.PP
|
|
\fB\-\-key\-hint\fP=""
|
|
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
|
|
|
|
.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)
|
|
|
|
.PP
|
|
\fB\-\-no\-cache\fP[=false]
|
|
do not use a local cache
|
|
|
|
.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 (\fB\fCkey=value\fR, can be specified multiple times)
|
|
|
|
.PP
|
|
\fB\-\-password\-command\fP=""
|
|
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
|
|
|
|
.PP
|
|
\fB\-p\fP, \fB\-\-password\-file\fP=""
|
|
\fB\fCfile\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=""
|
|
\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)
|
|
|
|
.PP
|
|
\fB\-\-tls\-client\-cert\fP=""
|
|
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
|
|
|
|
.PP
|
|
\fB\-v\fP, \fB\-\-verbose\fP[=0]
|
|
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|