2020-11-05 08:41:35 +00:00
|
|
|
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
|
2017-08-05 09:42:37 +00:00
|
|
|
.nh
|
2020-11-05 08:41:35 +00:00
|
|
|
.ad l
|
|
|
|
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
.PP
|
2017-09-11 19:05:51 +00:00
|
|
|
restic\-mount \- Mount the repository
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.PP
|
|
|
|
\fBrestic mount [flags] mountpoint\fP
|
|
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.PP
|
|
|
|
The "mount" command mounts the repository via fuse to a directory. This is a
|
|
|
|
read\-only mount.
|
|
|
|
|
|
|
|
|
2018-02-17 19:27:28 +00:00
|
|
|
.SH Snapshot Directories
|
|
|
|
.PP
|
|
|
|
If you need a different template for all directories that contain snapshots,
|
|
|
|
you can pass a template via \-\-snapshot\-template. Example without colons:
|
|
|
|
|
|
|
|
.PP
|
|
|
|
.RS
|
|
|
|
|
|
|
|
.nf
|
|
|
|
\-\-snapshot\-template "2006\-01\-02\_15\-04\-05"
|
|
|
|
|
|
|
|
.fi
|
|
|
|
.RE
|
|
|
|
|
|
|
|
.PP
|
|
|
|
You need to specify a sample format for exactly the following timestamp:
|
|
|
|
|
|
|
|
.PP
|
|
|
|
.RS
|
|
|
|
|
|
|
|
.nf
|
|
|
|
Mon Jan 2 15:04:05 \-0700 MST 2006
|
|
|
|
|
|
|
|
.fi
|
|
|
|
.RE
|
|
|
|
|
|
|
|
.PP
|
|
|
|
For details please see the documentation for time.Format() at:
|
2020-11-05 08:41:35 +00:00
|
|
|
|
|
|
|
\[la]https://godoc.org/time#Time.Format\[ra]
|
2020-09-19 15:38:26 +00:00
|
|
|
|
|
|
|
|
|
|
|
.SH EXIT STATUS
|
|
|
|
.PP
|
|
|
|
Exit status is 0 if the command was successful, and non\-zero if there was any error.
|
2018-02-17 19:27:28 +00:00
|
|
|
|
|
|
|
|
2017-08-05 09:42:37 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
.PP
|
|
|
|
\fB\-\-allow\-other\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
allow other users to access the data in the mounted directory
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.PP
|
|
|
|
\fB\-h\fP, \fB\-\-help\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
help for mount
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.PP
|
2020-09-19 15:38:26 +00:00
|
|
|
\fB\-H\fP, \fB\-\-host\fP=[]
|
2020-11-05 08:41:35 +00:00
|
|
|
only consider snapshots for this host (can be specified multiple times)
|
2017-08-05 09:42:37 +00:00
|
|
|
|
2019-01-06 20:40:32 +00:00
|
|
|
.PP
|
|
|
|
\fB\-\-no\-default\-permissions\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
for 'allow\-other', ignore Unix permissions and allow users to read all snapshot files
|
2019-01-06 20:40:32 +00:00
|
|
|
|
2017-08-05 09:42:37 +00:00
|
|
|
.PP
|
|
|
|
\fB\-\-owner\-root\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
use 'root' as the owner of files and dirs
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.PP
|
|
|
|
\fB\-\-path\fP=[]
|
2020-11-05 08:41:35 +00:00
|
|
|
only consider snapshots which include this (absolute) \fB\fCpath\fR
|
2017-08-05 09:42:37 +00:00
|
|
|
|
2018-02-17 19:27:28 +00:00
|
|
|
.PP
|
|
|
|
\fB\-\-snapshot\-template\fP="2006\-01\-02T15:04:05Z07:00"
|
2020-11-05 08:41:35 +00:00
|
|
|
set \fB\fCtemplate\fR to use for snapshot dirs
|
2018-02-17 19:27:28 +00:00
|
|
|
|
2017-08-05 09:42:37 +00:00
|
|
|
.PP
|
|
|
|
\fB\-\-tag\fP=[]
|
2020-11-05 08:41:35 +00:00
|
|
|
only consider snapshots which include this \fB\fCtaglist\fR
|
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=[]
|
2020-11-05 08:41:35 +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=""
|
2020-11-05 08:41:35 +00:00
|
|
|
set the cache \fB\fCdirectory\fR\&. (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]
|
2020-11-05 08:41:35 +00:00
|
|
|
auto remove old cache directories
|
2017-12-27 21:31:03 +00:00
|
|
|
|
2017-08-05 09:42:37 +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
|
2017-08-05 09:42:37 +00:00
|
|
|
|
2019-01-06 20:40:32 +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)
|
2019-01-06 20:40:32 +00:00
|
|
|
|
2017-11-26 18:46:16 +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)
|
2017-11-26 18:46:16 +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)
|
2017-11-26 18:46:16 +00:00
|
|
|
|
2017-09-24 21:13:04 +00:00
|
|
|
.PP
|
|
|
|
\fB\-\-no\-cache\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
do not use a local cache
|
2017-09-24 21:13:04 +00:00
|
|
|
|
2017-08-05 09:42:37 +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
|
2017-08-05 09:42:37 +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)
|
2017-08-05 09:42:37 +00:00
|
|
|
|
2019-01-06 20:40:32 +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)
|
2019-01-06 20:40:32 +00:00
|
|
|
|
2017-08-05 09:42:37 +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)
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.PP
|
|
|
|
\fB\-q\fP, \fB\-\-quiet\fP[=false]
|
2020-11-05 08:41:35 +00:00
|
|
|
do not output comprehensive progress report
|
2017-08-05 09:42:37 +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)
|
2017-08-05 09:42:37 +00:00
|
|
|
|
2018-02-17 19:27:28 +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
|
2018-02-17 19:27:28 +00:00
|
|
|
|
2018-05-21 13:57:32 +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)
|
2018-05-21 13:57:32 +00:00
|
|
|
|
2017-08-05 09:42:37 +00:00
|
|
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
.PP
|
|
|
|
\fBrestic(1)\fP
|