restic/doc/man/restic-backup.1

.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""

.SH NAME
.PP
restic-backup - Create a new backup of files and/or directories


.SH SYNOPSIS
.PP
\fBrestic backup [flags] [FILE/DIR] ...\fP


.SH DESCRIPTION
.PP
The "backup" command creates a new snapshot and saves the files and directories
given as the arguments.


.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).


.SH OPTIONS
.PP
\fB-n\fP, \fB--dry-run\fP[=false]
	do not upload or write any data, just show what would be done

.PP
\fB-e\fP, \fB--exclude\fP=[]
	exclude a \fBpattern\fR (can be specified multiple times)

.PP
\fB--exclude-caches\fP[=false]
	excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard

.PP
\fB--exclude-file\fP=[]
	read exclude patterns from a \fBfile\fR (can be specified multiple times)

.PP
\fB--exclude-if-present\fP=[]
	takes \fBfilename[:header]\fR, exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)

.PP
\fB--exclude-larger-than\fP=""
	max \fBsize\fR of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)

.PP
\fB--files-from\fP=[]
	read the files to backup from \fBfile\fR (can be combined with file args; can be specified multiple times)

.PP
\fB--files-from-raw\fP=[]
	read the files to backup from \fBfile\fR (can be combined with file args; can be specified multiple times)

.PP
\fB--files-from-verbatim\fP=[]
	read the files to backup from \fBfile\fR (can be combined with file args; can be specified multiple times)

.PP
\fB-f\fP, \fB--force\fP[=false]
	force re-reading the target files/directories (overrides the "parent" flag)

.PP
\fB-g\fP, \fB--group-by\fP=host,paths
	\fBgroup\fR snapshots by host, paths and/or tags, separated by comma (disable grouping with '')

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for backup

.PP
\fB-H\fP, \fB--host\fP=""
	set the \fBhostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag

.PP
\fB--iexclude\fP=[]
	same as --exclude \fBpattern\fR but ignores the casing of filenames

.PP
\fB--iexclude-file\fP=[]
	same as --exclude-file but ignores casing of \fBfile\fRnames in patterns

.PP
\fB--ignore-ctime\fP[=false]
	ignore ctime changes when checking for modified files

.PP
\fB--ignore-inode\fP[=false]
	ignore inode number changes when checking for modified files

.PP
\fB--no-scan\fP[=false]
	do not run scanner to estimate size of backup

.PP
\fB-x\fP, \fB--one-file-system\fP[=false]
	exclude other file systems, don't cross filesystem boundaries and subvolumes

.PP
\fB--parent\fP=""
	use this parent \fBsnapshot\fR (default: latest snapshot in the group determined by --group-by and not newer than the timestamp determined by --time)

.PP
\fB--read-concurrency\fP=0
	read \fBn\fR files concurrently (default: $RESTIC_READ_CONCURRENCY or 2)

.PP
\fB--stdin\fP[=false]
	read backup from stdin

.PP
\fB--stdin-filename\fP="stdin"
	\fBfilename\fR to use when reading from stdin

.PP
\fB--tag\fP=[]
	add \fBtags\fR for the new snapshot in the format \fBtag[,tag,...]\fR (can be specified multiple times)

.PP
\fB--time\fP=""
	\fBtime\fR of the backup (ex. '2012-11-01 22:08:41') (default: now)

.PP
\fB--with-atime\fP[=false]
	store the atime for all files and directories


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
	\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)

.PP
\fB--cache-dir\fP=""
	set the cache \fBdirectory\fR\&. (default: use system default cache directory)

.PP
\fB--cleanup-cache\fP[=false]
	auto remove old cache directories

.PP
\fB--compression\fP=auto
	compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)

.PP
\fB--insecure-tls\fP[=false]
	skip TLS certificate verification when connecting to the repository (insecure)

.PP
\fB--json\fP[=false]
	set output mode to JSON for commands that support it

.PP
\fB--key-hint\fP=""
	\fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)

.PP
\fB--limit-download\fP=0
	limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)

.PP
\fB--limit-upload\fP=0
	limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)

.PP
\fB--no-cache\fP[=false]
	do not use a local cache

.PP
\fB--no-extra-verify\fP[=false]
	skip additional verification of data before upload (see documentation)

.PP
\fB--no-lock\fP[=false]
	do not lock the repository, this allows some operations on read-only repositories

.PP
\fB-o\fP, \fB--option\fP=[]
	set extended option (\fBkey=value\fR, can be specified multiple times)

.PP
\fB--pack-size\fP=0
	set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)

.PP
\fB--password-command\fP=""
	shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)

.PP
\fB-p\fP, \fB--password-file\fP=""
	\fBfile\fR to read the repository password from (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=""
	\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)

.PP
\fB--repository-file\fP=""
	\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)

.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)

.PP
\fB--tls-client-cert\fP=""
	path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)

.PP
\fB-v\fP, \fB--verbose\fP[=0]
	be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)


.SH SEE ALSO
.PP
\fBrestic(1)\fP