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
2017-09-11 19:05:51 +00:00
restic\- backup \- Create a new backup of files and/or directories
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
\fB restic backup [flags] FILE/DIR [FILE/DIR] ...\fP
.SH DESCRIPTION
.PP
The "backup" command creates a new snapshot and saves the files and directories
given as the arguments.
.SH OPTIONS
.PP
\fB \- e\fP , \fB \- \- exclude\fP =[]
exclude a \fB \fC pattern\fR (can be specified multiple times)
2017-08-19 20:44:18 +00:00
.PP
\fB \- \- exclude\- caches\fP [=false]
2019-04-02 13:53:07 +00:00
excludes cache directories that are marked with a CACHEDIR.TAG file. See http://bford.info/cachedir/spec.html for the Cache Directory Tagging Standard
2017-08-19 20:44:18 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB \- \- exclude\- file\fP =[]
read exclude patterns from a \fB \fC file\fR (can be specified multiple times)
2017-08-19 20:44:18 +00:00
.PP
2017-09-10 13:33:20 +00:00
\fB \- \- exclude\- if\- present\fP =[]
takes filename[:header], exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)
2017-08-19 20:44:18 +00:00
2017-08-05 09:42:37 +00:00
.PP
2019-01-06 20:40:32 +00:00
\fB \- \- files\- from\fP =[]
read the files to backup from file (can be combined with file args/can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB \- f\fP , \fB \- \- force\fP [=false]
force re\- reading the target files/directories (overrides the "parent" flag)
.PP
\fB \- h\fP , \fB \- \- help\fP [=false]
help for backup
.PP
2019-01-06 20:40:32 +00:00
\fB \- H\fP , \fB \- \- host\fP =""
2017-09-22 12:29:04 +00:00
set the \fB \fC hostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag
2017-08-05 09:42:37 +00:00
.PP
\fB \- x\fP , \fB \- \- one\- file\- system\fP [=false]
exclude other file systems
.PP
\fB \- \- parent\fP =""
use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)
.PP
\fB \- \- stdin\fP [=false]
read backup from stdin
.PP
\fB \- \- stdin\- filename\fP ="stdin"
file name to use when reading from stdin
.PP
\fB \- \- tag\fP =[]
add a \fB \fC tag\fR for the new snapshot (can be specified multiple times)
2017-09-09 10:10:38 +00:00
.PP
\fB \- \- time\fP =""
time of the backup (ex. '2012\- 11\- 01 22:08:41') (default: now)
2017-12-27 21:31:03 +00:00
.PP
\fB \- \- with\- atime\fP [=false]
store the atime for all files and directories
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 =[]
2018-05-21 13:57:32 +00:00
\fB \fC file\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 \- \- 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 \fC key=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 \fC n\fR )
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fB restic(1)\fP