restic/doc/man/restic.1

95 lines
2.6 KiB
Groff
Raw Normal View History

2017-09-26 11:16:08 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2017-08-05 09:42:37 +00:00
.nh
.ad l
.SH NAME
.PP
restic \- Backup and restore files
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
\fBrestic [flags]\fP
.SH DESCRIPTION
.PP
restic is a backup program which allows saving multiple revisions of files and
directories in an encrypted repository stored on different backends.
.SH OPTIONS
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-cacert\fP=[]
2018-05-21 13:57:32 +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=""
2018-10-13 11:48:30 +00:00
set the cache directory. (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]
auto remove old cache directories
2017-08-05 09:42:37 +00:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for restic
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2017-11-26 18:46:16 +00:00
.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)
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
do not use a local cache
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repo, this allows some operations on read\-only repos
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND)
2017-08-05 09:42:37 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (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=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
2018-05-21 13:57:32 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR)
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
2019-01-06 20:40:32 +00:00
\fBrestic\-backup(1)\fP, \fBrestic\-cache(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-diff(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-recover(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-self\-update(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-stats(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP