restic/doc/man/restic-backup.1

190 lines
5.0 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
restic\-backup \- Create a new backup of files and/or directories
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
\fBrestic 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.
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful.
Exit status is 1 if there was a fatal error (no snapshot created).
Exit status is 3 if some source data could not be read (incomplete snapshot created).
2017-08-05 09:42:37 +00:00
.SH OPTIONS
.PP
\fB\-e\fP, \fB\-\-exclude\fP=[]
2021-08-03 09:45:36 +00:00
exclude a \fB\fCpattern\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-exclude\-caches\fP[=false]
2021-08-03 09:45:36 +00:00
excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-exclude\-file\fP=[]
2021-08-03 09:45:36 +00:00
read exclude patterns from a \fB\fCfile\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
2017-09-10 13:33:20 +00:00
\fB\-\-exclude\-if\-present\fP=[]
2021-08-03 09:45:36 +00:00
takes \fB\fCfilename[:header]\fR, exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-exclude\-larger\-than\fP=""
2021-08-03 09:45:36 +00:00
max \fB\fCsize\fR of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)
2017-08-05 09:42:37 +00:00
.PP
2019-01-06 20:40:32 +00:00
\fB\-\-files\-from\fP=[]
2021-08-03 09:45:36 +00:00
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
2021-02-14 10:44:20 +00:00
.PP
\fB\-\-files\-from\-raw\fP=[]
2021-08-03 09:45:36 +00:00
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
2021-02-14 10:44:20 +00:00
.PP
\fB\-\-files\-from\-verbatim\fP=[]
2021-08-03 09:45:36 +00:00
read the files to backup from \fB\fCfile\fR (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]
2021-08-03 09:45:36 +00:00
force re\-reading the target files/directories (overrides the "parent" flag)
2017-08-05 09:42:37 +00:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2021-08-03 09:45:36 +00:00
help for backup
2017-08-05 09:42:37 +00:00
.PP
2019-01-06 20:40:32 +00:00
\fB\-H\fP, \fB\-\-host\fP=""
2021-08-03 09:45:36 +00:00
set the \fB\fChostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag
2017-08-05 09:42:37 +00:00
2019-04-23 11:19:39 +00:00
.PP
\fB\-\-iexclude\fP=[]
2021-08-03 09:45:36 +00:00
same as \-\-exclude \fB\fCpattern\fR but ignores the casing of filenames
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-iexclude\-file\fP=[]
2021-08-03 09:45:36 +00:00
same as \-\-exclude\-file but ignores casing of \fB\fCfile\fRnames in patterns
2019-04-23 11:19:39 +00:00
2021-02-14 10:44:20 +00:00
.PP
\fB\-\-ignore\-ctime\fP[=false]
2021-08-03 09:45:36 +00:00
ignore ctime changes when checking for modified files
2021-02-14 10:44:20 +00:00
2019-04-23 11:19:39 +00:00
.PP
\fB\-\-ignore\-inode\fP[=false]
2021-08-03 09:45:36 +00:00
ignore inode number changes when checking for modified files
2019-04-23 11:19:39 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-x\fP, \fB\-\-one\-file\-system\fP[=false]
2021-08-03 09:45:36 +00:00
exclude other file systems, don't cross filesystem boundaries and subvolumes
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-parent\fP=""
2021-08-03 09:45:36 +00:00
use this parent \fB\fCsnapshot\fR (default: last snapshot in the repo that has the same target files/directories)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-stdin\fP[=false]
2021-08-03 09:45:36 +00:00
read backup from stdin
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-stdin\-filename\fP="stdin"
2021-08-03 09:45:36 +00:00
\fB\fCfilename\fR to use when reading from stdin
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-tag\fP=[]
2021-08-03 09:45:36 +00:00
add \fB\fCtags\fR for the new snapshot in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2017-09-09 10:10:38 +00:00
.PP
\fB\-\-time\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCtime\fR of the backup (ex. '2012\-11\-01 22:08:41') (default: now)
2017-09-09 10:10:38 +00:00
2017-12-27 21:31:03 +00:00
.PP
\fB\-\-with\-atime\fP[=false]
2021-08-03 09:45:36 +00:00
store the atime for all files and directories
2017-12-27 21:31:03 +00:00
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=[]
2021-08-03 09:45:36 +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=""
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
\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
\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
\fB\-\-key\-hint\fP=""
2021-08-03 09:45:36 +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
2021-08-03 09:45:36 +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
2021-08-03 09:45:36 +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]
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
\fB\-\-no\-lock\fP[=false]
2021-08-03 09:45:36 +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=[]
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
\fB\-\-password\-command\fP=""
2021-08-03 09:45:36 +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=""
2021-08-03 09:45:36 +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]
2021-08-03 09:45:36 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2021-08-03 09:45:36 +00:00
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
2020-11-05 08:41:35 +00:00
.PP
\fB\-\-repository\-file\fP=""
2021-08-03 09:45:36 +00:00
\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=""
2021-08-03 09:45:36 +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]
2021-08-03 09:45:36 +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