restic/doc/man/restic.1

116 lines
3.4 KiB
Groff
Raw Normal View History

2017-08-05 09:42:37 +00:00
.nh
2021-08-03 09:45:36 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
2022-08-25 17:55:00 +00:00
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.
2023-07-31 18:23:24 +00:00
.PP
The full documentation can be found at https://restic.readthedocs.io/ .
2017-08-05 09:42:37 +00:00
.SH OPTIONS
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cacert\fP=[]
2023-07-31 18:23:24 +00:00
\fB\fCfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cache-dir\fP=""
2021-08-03 09:45:36 +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
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
2017-12-27 21:31:03 +00:00
2017-08-05 09:42:37 +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
.PP
\fB-h\fP, \fB--help\fP[=false]
2021-08-03 09:45:36 +00:00
help for restic
2017-08-05 09:42:37 +00:00
2022-03-26 19:09:59 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
2022-03-26 19:09:59 +00:00
2017-08-05 09:42:37 +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
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--key-hint\fP=""
\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
2022-08-25 17:55:00 +00:00
\fB--limit-download\fP=0
2023-01-12 19:51:19 +00:00
limits downloads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--limit-upload\fP=0
2023-01-12 19:51:19 +00:00
limits uploads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +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
2017-09-24 21:13:04 +00:00
2017-08-05 09:42:37 +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
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-o\fP, \fB--option\fP=[]
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB--pack-size\fP=0
2023-01-12 19:51:19 +00:00
set target pack \fB\fCsize\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=""
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
2022-08-25 17:55:00 +00:00
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
2017-08-05 09:42:37 +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
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-r\fP, \fB--repo\fP=""
\fB\fCrepository\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=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
2017-08-05 09:42:37 +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)
2018-02-17 19:27:28 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tls-client-cert\fP=""
2023-07-31 18:23:24 +00:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
2018-02-17 19:27:28 +00:00
2018-05-21 13:57:32 +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)
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
2023-07-31 18:23:24 +00:00
\fBrestic-backup(1)\fP, \fBrestic-cache(1)\fP, \fBrestic-cat(1)\fP, \fBrestic-check(1)\fP, \fBrestic-copy(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-recover(1)\fP, \fBrestic-repair(1)\fP, \fBrestic-restore(1)\fP, \fBrestic-rewrite(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