octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-16 01:57:10 +00:00
Code Issues Releases Wiki Activity
89938bc21c
restic/doc/man/restic-backup.1

105 lines
2.4 KiB
Groff
Raw Normal View History

Use deterministic date for man pages
2017-09-02 07:27:11 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" ""
Add generated manual pages
2017-08-05 09:42:37 +00:00
.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)
Add option to exclude directories with a tagfile The option is named --exclude-if-present and accepts a parameter filename[:content]. Directories are excluded and their contents is not backed up if they contain a file with the specified name and, optionally, that starts with the specified content. The tagfile itself is never excluded. There is also a shortcut --exclude-caches that works in the same way as the likewise-named option of tar(1): Directories are recognized as cache if they contain a file named "CACHEDIR.TAG. Closes #317.
2017-08-19 20:44:18 +00:00
.PP
\fB\-\-exclude\-caches\fP[=false]
excludes cache directories that are marked with a CACHEDIR.TAG file
Add generated manual pages
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-exclude\-file\fP=[]
read exclude patterns from a \fB\fCfile\fR (can be specified multiple times)
Add option to exclude directories with a tagfile The option is named --exclude-if-present and accepts a parameter filename[:content]. Directories are excluded and their contents is not backed up if they contain a file with the specified name and, optionally, that starts with the specified content. The tagfile itself is never excluded. There is also a shortcut --exclude-caches that works in the same way as the likewise-named option of tar(1): Directories are recognized as cache if they contain a file named "CACHEDIR.TAG. Closes #317.
2017-08-19 20:44:18 +00:00
.PP
Update manual pages
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)
Add option to exclude directories with a tagfile The option is named --exclude-if-present and accepts a parameter filename[:content]. Directories are excluded and their contents is not backed up if they contain a file with the specified name and, optionally, that starts with the specified content. The tagfile itself is never excluded. There is also a shortcut --exclude-caches that works in the same way as the likewise-named option of tar(1): Directories are recognized as cache if they contain a file named "CACHEDIR.TAG. Closes #317.
2017-08-19 20:44:18 +00:00
Add generated manual pages
2017-08-05 09:42:37 +00:00
.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
backup: Do not print hostname in help text This is necessary so that the manpage generation is deterministic and we can test if the man pages are up to date when the CI tests run.
2017-08-05 09:54:59 +00:00
\fB\-\-hostname\fP=""
Add generated manual pages
2017-08-05 09:42:37 +00:00
set the \fB\fChostname\fR for the snapshot manually
.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)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it
.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)
.SH SEE ALSO
.PP
\fBrestic(1)\fP
Copy Permalink