mirror of
https://github.com/octoleo/restic.git
synced 2024-11-30 00:33:57 +00:00
141 lines
3.2 KiB
Groff
141 lines
3.2 KiB
Groff
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
|
|
.nh
|
|
.ad l
|
|
|
|
|
|
.SH NAME
|
|
.PP
|
|
restic\-backup \- Create a new backup of files and/or directories
|
|
|
|
|
|
.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.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB\-e\fP, \fB\-\-exclude\fP=[]
|
|
exclude a \fB\fCpattern\fR (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB\-\-exclude\-caches\fP[=false]
|
|
excludes cache directories that are marked with a CACHEDIR.TAG file
|
|
|
|
.PP
|
|
\fB\-\-exclude\-file\fP=[]
|
|
read exclude patterns from a \fB\fCfile\fR (can be specified multiple times)
|
|
|
|
.PP
|
|
\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)
|
|
|
|
.PP
|
|
\fB\-\-files\-from\fP=""
|
|
read the files to backup from file (can be combined with file args)
|
|
|
|
.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
|
|
\fB\-\-hostname\fP=""
|
|
set the \fB\fChostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag
|
|
|
|
.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\fCtag\fR for the new snapshot (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB\-\-time\fP=""
|
|
time 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=[]
|
|
path to load root certificates from (default: use system certificates)
|
|
|
|
.PP
|
|
\fB\-\-cache\-dir\fP=""
|
|
set the cache directory
|
|
|
|
.PP
|
|
\fB\-\-cleanup\-cache\fP[=false]
|
|
auto remove old cache directories
|
|
|
|
.PP
|
|
\fB\-\-json\fP[=false]
|
|
set output mode to JSON for commands that support it
|
|
|
|
.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)
|
|
|
|
.PP
|
|
\fB\-\-no\-cache\fP[=false]
|
|
do not use a local cache
|
|
|
|
.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)
|
|
|
|
.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)
|
|
|
|
.PP
|
|
\fB\-\-tls\-client\-cert\fP=""
|
|
path to a file containing PEM encoded TLS client certificate and private key
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|