TrueCloudLab/restic
16
0
Fork 3
Code Issues 2 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Update manpages and auto-completion

Browse source
This commit is contained in:
Alexander Neumann 2020-09-19 17:38:26 +02:00
parent ee6e981b4e
commit c8a94eced7
29 changed files with 2266 additions and 671 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

524
doc/bash-completion.sh
View file

File diff suppressed because it is too large Load diff

49
doc/man/restic-backup.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -19,6 +18,13 @@ The "backup" command creates a new snapshot and saves the files and directories
given as the arguments. 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 .SH OPTIONS
.PP .PP
\fB\-e\fP, \fB\-\-exclude\fP=[] \fB\-e\fP, \fB\-\-exclude\fP=[]
@ -26,8 +32,7 @@ given as the arguments.
.PP .PP
\fB\-\-exclude\-caches\fP[=false] \fB\-\-exclude\-caches\fP[=false]
excludes cache directories that are marked with a CACHEDIR.TAG file. See excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard
\[la]http://bford.info/cachedir/spec.html\[ra] for the Cache Directory Tagging Standard
.PP .PP
\fB\-\-exclude\-file\fP=[] \fB\-\-exclude\-file\fP=[]
@ -35,11 +40,15 @@ given as the arguments.
.PP .PP
\fB\-\-exclude\-if\-present\fP=[] \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) 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)
.PP
\fB\-\-exclude\-larger\-than\fP=""
max \fB\fCsize\fR of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)
.PP .PP
\fB\-\-files\-from\fP=[] \fB\-\-files\-from\fP=[]
read the files to backup from file (can be combined with file args/can be specified multiple times) read the files to backup from \fB\fCfile\fR (can be combined with file args/can be specified multiple times)
.PP .PP
\fB\-f\fP, \fB\-\-force\fP[=false] \fB\-f\fP, \fB\-\-force\fP[=false]
@ -55,7 +64,11 @@ given as the arguments.
.PP .PP
\fB\-\-iexclude\fP=[] \fB\-\-iexclude\fP=[]
same as \fB\fC\-\-exclude\fR but ignores the casing of filenames same as \-\-exclude \fB\fCpattern\fR but ignores the casing of filenames
.PP
\fB\-\-iexclude\-file\fP=[]
same as \-\-exclude\-file but ignores casing of \fB\fCfile\fRnames in patterns
.PP .PP
\fB\-\-ignore\-inode\fP[=false] \fB\-\-ignore\-inode\fP[=false]
@ -67,7 +80,7 @@ given as the arguments.
.PP .PP
\fB\-\-parent\fP="" \fB\-\-parent\fP=""
use this parent snapshot (default: last snapshot in the repo that has the same target files/directories) use this parent \fB\fCsnapshot\fR (default: last snapshot in the repo that has the same target files/directories)
.PP .PP
\fB\-\-stdin\fP[=false] \fB\-\-stdin\fP[=false]
@ -75,7 +88,7 @@ given as the arguments.
.PP .PP
\fB\-\-stdin\-filename\fP="stdin" \fB\-\-stdin\-filename\fP="stdin"
file name to use when reading from stdin \fB\fCfilename\fR to use when reading from stdin
.PP .PP
\fB\-\-tag\fP=[] \fB\-\-tag\fP=[]
@ -83,7 +96,7 @@ given as the arguments.
.PP .PP
\fB\-\-time\fP="" \fB\-\-time\fP=""
time of the backup (ex. '2012\-11\-01 22:08:41') (default: now) \fB\fCtime\fR of the backup (ex. '2012\-11\-01 22:08:41') (default: now)
.PP .PP
\fB\-\-with\-atime\fP[=false] \fB\-\-with\-atime\fP[=false]
@ -97,7 +110,7 @@ given as the arguments.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -109,7 +122,7 @@ given as the arguments.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -133,11 +146,11 @@ given as the arguments.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -145,15 +158,15 @@ given as the arguments.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-cache.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -18,6 +17,11 @@ restic\-cache \- Operate on local cache directories
The "cache" command allows listing and cleaning local cache directories. The "cache" command allows listing and cleaning local cache directories.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-cleanup\fP[=false] \fB\-\-cleanup\fP[=false]
@ -43,7 +47,7 @@ The "cache" command allows listing and cleaning local cache directories.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -55,7 +59,7 @@ The "cache" command allows listing and cleaning local cache directories.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -79,11 +83,11 @@ The "cache" command allows listing and cleaning local cache directories.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -91,15 +95,15 @@ The "cache" command allows listing and cleaning local cache directories.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-cat.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -18,6 +17,11 @@ restic\-cat \- Print internal objects to stdout
The "cat" command is used to print internal objects to stdout. The "cat" command is used to print internal objects to stdout.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -31,7 +35,7 @@ The "cat" command is used to print internal objects to stdout.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -43,7 +47,7 @@ The "cat" command is used to print internal objects to stdout.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -67,11 +71,11 @@ The "cat" command is used to print internal objects to stdout.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -79,15 +83,15 @@ The "cat" command is used to print internal objects to stdout.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-check.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -23,6 +22,11 @@ By default, the "check" command will always load all data directly from the
repository and not use a local cache. repository and not use a local cache.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-check\-unused\fP[=false] \fB\-\-check\-unused\fP[=false]
@ -52,7 +56,7 @@ repository and not use a local cache.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -64,7 +68,7 @@ repository and not use a local cache.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -88,11 +92,11 @@ repository and not use a local cache.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -100,15 +104,15 @@ repository and not use a local cache.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

127
doc/man/restic-copy.1 Normal file
View file

@ -0,0 +1,127 @@
.nh
.TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME
.PP
restic\-copy \- Copy snapshots from one repository to another
.SH SYNOPSIS
.PP
\fBrestic copy [flags] [snapshotID ...]\fP
.SH DESCRIPTION
.PP
The "copy" command copies one or more snapshots from one repository to another
repository. Note that this will have to read (download) and write (upload) the
entire snapshot(s) due to the different encryption keys on the source and
destination, and that transferred files are not re\-chunked, which may break
their deduplication. This can be mitigated by the "\-\-copy\-chunker\-params"
option when initializing a new destination repository using the "init" command.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for copy
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP
\fB\-\-key\-hint2\fP=""
key ID of key to try decrypting the destination repository first (default: $RESTIC\_KEY\_HINT2)
.PP
\fB\-\-password\-command2\fP=""
shell \fB\fCcommand\fR to obtain the destination repository password from (default: $RESTIC\_PASSWORD\_COMMAND2)
.PP
\fB\-\-password\-file2\fP=""
\fB\fCfile\fR to read the destination repository password from (default: $RESTIC\_PASSWORD\_FILE2)
.PP
\fB\-\-path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot ID is given
.PP
\fB\-\-repo2\fP=""
destination repository to copy snapshots to (default: $RESTIC\_REPOSITORY2)
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot ID is given
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default 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\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.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\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\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=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO
.PP
\fBrestic(1)\fP

26
doc/man/restic-diff.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-diff \- Show differences between two snapshots
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic diff snapshot\-ID snapshot\-ID [flags]\fP \fBrestic diff [flags] snapshot\-ID snapshot\-ID\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -34,6 +33,11 @@ T The type was changed, e.g. a file was made a symlink
.RE .RE
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -51,7 +55,7 @@ T The type was changed, e.g. a file was made a symlink
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -63,7 +67,7 @@ T The type was changed, e.g. a file was made a symlink
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -87,11 +91,11 @@ T The type was changed, e.g. a file was made a symlink
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -99,15 +103,15 @@ T The type was changed, e.g. a file was made a symlink
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

34
doc/man/restic-dump.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -15,22 +14,29 @@ restic\-dump \- Print a backed\-up file to stdout
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The "dump" command extracts a single file from a snapshot from the repository and The "dump" command extracts files from a snapshot from the repository. If a
prints its contents to stdout. single file is selected, it prints its contents to stdout. Folders are output
as a tar file containing the contents of the specified folder. Pass "/" as
file name to dump the whole snapshot as a tar file.
.PP .PP
The special snapshot "latest" can be used to use the latest snapshot in the The special snapshot "latest" can be used to use the latest snapshot in the
repository. repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
help for dump help for dump
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this host when the snapshot ID is "latest" only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)
.PP .PP
\fB\-\-path\fP=[] \fB\-\-path\fP=[]
@ -48,7 +54,7 @@ repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -60,7 +66,7 @@ repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -84,11 +90,11 @@ repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -96,15 +102,15 @@ repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

29
doc/man/restic-find.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -30,8 +29,8 @@ It can also be used to search for restic blobs or trees for troubleshooting.
help for find help for find
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP .PP
\fB\-i\fP, \fB\-\-ignore\-case\fP[=false] \fB\-i\fP, \fB\-\-ignore\-case\fP[=false]
@ -81,7 +80,7 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -93,7 +92,7 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -117,11 +116,11 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -129,15 +128,15 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH EXAMPLE .SH EXAMPLE
@ -152,6 +151,12 @@ restic find \-\-show\-pack\-id \-\-blob 420f620f
restic find \-\-tree 577c2bc9 f81f2e22 a62827a9 restic find \-\-tree 577c2bc9 f81f2e22 a62827a9
restic find \-\-pack 025c1d06 restic find \-\-pack 025c1d06
EXIT STATUS
===========
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.fi .fi
.RE .RE

28
doc/man/restic-forget.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -21,6 +20,11 @@ is a reference to data stored there. In order to remove this (now unreferenced)
data after 'forget' was run successfully, see the 'prune' command. data after 'forget' was run successfully, see the 'prune' command.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-l\fP, \fB\-\-keep\-last\fP=0 \fB\-l\fP, \fB\-\-keep\-last\fP=0
@ -55,8 +59,8 @@ data after 'forget' was run successfully, see the 'prune' command.
keep snapshots with this \fB\fCtaglist\fR (can be specified multiple times) keep snapshots with this \fB\fCtaglist\fR (can be specified multiple times)
.PP .PP
\fB\-\-host\fP="" \fB\-\-host\fP=[]
only consider snapshots with the given \fB\fChost\fR only consider snapshots with the given \fB\fChost\fR (can be specified multiple times)
.PP .PP
\fB\-\-tag\fP=[] \fB\-\-tag\fP=[]
@ -94,7 +98,7 @@ data after 'forget' was run successfully, see the 'prune' command.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -106,7 +110,7 @@ data after 'forget' was run successfully, see the 'prune' command.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -130,11 +134,11 @@ data after 'forget' was run successfully, see the 'prune' command.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -142,15 +146,15 @@ data after 'forget' was run successfully, see the 'prune' command.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

26
doc/man/restic-generate.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-generate \- Generate manual pages and auto\-completion files (bash, zsh)
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic generate [command] [flags]\fP \fBrestic generate [flags]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -19,6 +18,11 @@ The "generate" command writes automatically generated files (like the man pages
and the auto\-completion files for bash and zsh). and the auto\-completion files for bash and zsh).
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-bash\-completion\fP="" \fB\-\-bash\-completion\fP=""
@ -44,7 +48,7 @@ and the auto\-completion files for bash and zsh).
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -56,7 +60,7 @@ and the auto\-completion files for bash and zsh).
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -80,11 +84,11 @@ and the auto\-completion files for bash and zsh).
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -92,15 +96,15 @@ and the auto\-completion files for bash and zsh).
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

44
doc/man/restic-init.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -18,11 +17,36 @@ restic\-init \- Initialize a new repository
The "init" command initializes a new repository. The "init" command initializes a new repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP
\fB\-\-copy\-chunker\-params\fP[=false]
copy chunker parameters from the secondary repository (useful with the copy command)
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
help for init help for init
.PP
\fB\-\-key\-hint2\fP=""
key ID of key to try decrypting the secondary repository first (default: $RESTIC\_KEY\_HINT2)
.PP
\fB\-\-password\-command2\fP=""
shell \fB\fCcommand\fR to obtain the secondary repository password from (default: $RESTIC\_PASSWORD\_COMMAND2)
.PP
\fB\-\-password\-file2\fP=""
\fB\fCfile\fR to read the secondary repository password from (default: $RESTIC\_PASSWORD\_FILE2)
.PP
\fB\-\-repo2\fP=""
secondary repository to copy chunker parameters from (default: $RESTIC\_REPOSITORY2)
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -31,7 +55,7 @@ The "init" command initializes a new repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -43,7 +67,7 @@ The "init" command initializes a new repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -67,11 +91,11 @@ The "init" command initializes a new repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -79,15 +103,15 @@ The "init" command initializes a new repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

36
doc/man/restic-key.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-key \- Manage keys (passwords)
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic key [list|add|remove|passwd] [ID] [flags]\fP \fBrestic key [flags] [list|add|remove|passwd] [ID]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -18,14 +17,27 @@ restic\-key \- Manage keys (passwords)
The "key" command manages keys (passwords) for accessing the repository. The "key" command manages keys (passwords) for accessing the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
help for key help for key
.PP
\fB\-\-host\fP=""
the hostname for new keys
.PP .PP
\fB\-\-new\-password\-file\fP="" \fB\-\-new\-password\-file\fP=""
the file from which to load a new password \fB\fCfile\fR from which to read the new password
.PP
\fB\-\-user\fP=""
the username for new keys
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -35,7 +47,7 @@ The "key" command manages keys (passwords) for accessing the repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -47,7 +59,7 @@ The "key" command manages keys (passwords) for accessing the repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -71,11 +83,11 @@ The "key" command manages keys (passwords) for accessing the repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -83,15 +95,15 @@ The "key" command manages keys (passwords) for accessing the repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

26
doc/man/restic-list.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-list \- List objects in the repository
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic list [blobs|packs|index|snapshots|keys|locks] [flags]\fP \fBrestic list [flags] [blobs|packs|index|snapshots|keys|locks]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -18,6 +17,11 @@ restic\-list \- List objects in the repository
The "list" command allows listing objects in the repository based on type. The "list" command allows listing objects in the repository based on type.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -31,7 +35,7 @@ The "list" command allows listing objects in the repository based on type.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -43,7 +47,7 @@ The "list" command allows listing objects in the repository based on type.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -67,11 +71,11 @@ The "list" command allows listing objects in the repository based on type.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -79,15 +83,15 @@ The "list" command allows listing objects in the repository based on type.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

30
doc/man/restic-ls.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-ls \- List files in a snapshot
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic ls [flags] [snapshotID] [dir...]\fP \fBrestic ls [flags] snapshotID [dir...]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -33,14 +32,19 @@ Any directory paths specified must be absolute (starting with
a path separator); paths use the forward slash '/' as separator. a path separator); paths use the forward slash '/' as separator.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
help for ls help for ls
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP .PP
\fB\-l\fP, \fB\-\-long\fP[=false] \fB\-l\fP, \fB\-\-long\fP[=false]
@ -66,7 +70,7 @@ a path separator); paths use the forward slash '/' as separator.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -78,7 +82,7 @@ a path separator); paths use the forward slash '/' as separator.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -102,11 +106,11 @@ a path separator); paths use the forward slash '/' as separator.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -114,15 +118,15 @@ a path separator); paths use the forward slash '/' as separator.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

26
doc/man/restic-migrate.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-migrate \- Apply migrations
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic migrate [name] [flags]\fP \fBrestic migrate [flags] [name]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -19,6 +18,11 @@ The "migrate" command applies migrations to a repository. When no migration
name is explicitly given, a list of migrations that can be applied is printed. name is explicitly given, a list of migrations that can be applied is printed.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-f\fP, \fB\-\-force\fP[=false] \fB\-f\fP, \fB\-\-force\fP[=false]
@ -36,7 +40,7 @@ name is explicitly given, a list of migrations that can be applied is printed.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -48,7 +52,7 @@ name is explicitly given, a list of migrations that can be applied is printed.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -72,11 +76,11 @@ name is explicitly given, a list of migrations that can be applied is printed.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -84,15 +88,15 @@ name is explicitly given, a list of migrations that can be applied is printed.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

29
doc/man/restic-mount.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -47,8 +46,12 @@ Mon Jan 2 15:04:05 \-0700 MST 2006
.PP .PP
For details please see the documentation for time.Format() at: For details please see the documentation for time.Format() at:
https://godoc.org/time#Time.Format
\[la]https://godoc.org/time#Time.Format\[ra]
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
@ -61,8 +64,8 @@ For details please see the documentation for time.Format() at:
help for mount help for mount
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this host only consider snapshots for this host (can be specified multiple times)
.PP .PP
\fB\-\-no\-default\-permissions\fP[=false] \fB\-\-no\-default\-permissions\fP[=false]
@ -92,7 +95,7 @@ For details please see the documentation for time.Format() at:
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -104,7 +107,7 @@ For details please see the documentation for time.Format() at:
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -128,11 +131,11 @@ For details please see the documentation for time.Format() at:
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -140,15 +143,15 @@ For details please see the documentation for time.Format() at:
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-prune.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -19,6 +18,11 @@ The "prune" command checks the repository and removes data that is not
referenced and therefore not needed any more. referenced and therefore not needed any more.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -32,7 +36,7 @@ referenced and therefore not needed any more.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -44,7 +48,7 @@ referenced and therefore not needed any more.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -68,11 +72,11 @@ referenced and therefore not needed any more.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -80,15 +84,15 @@ referenced and therefore not needed any more.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-rebuild-index.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -19,6 +18,11 @@ The "rebuild\-index" command creates a new index based on the pack files in the
repository. repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -32,7 +36,7 @@ repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -44,7 +48,7 @@ repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -68,11 +72,11 @@ repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -80,15 +84,15 @@ repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-recover.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -20,6 +19,11 @@ the raw data of the repository. It can be used if, for example, a snapshot has
been removed by accident with "forget". been removed by accident with "forget".
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -33,7 +37,7 @@ been removed by accident with "forget".
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -45,7 +49,7 @@ been removed by accident with "forget".
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -69,11 +73,11 @@ been removed by accident with "forget".
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -81,15 +85,15 @@ been removed by accident with "forget".
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

28
doc/man/restic-restore.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -23,6 +22,11 @@ The special snapshot "latest" can be used to restore the latest snapshot in the
repository. repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-e\fP, \fB\-\-exclude\fP=[] \fB\-e\fP, \fB\-\-exclude\fP=[]
@ -33,8 +37,8 @@ repository.
help for restore help for restore
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this host when the snapshot ID is "latest" only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)
.PP .PP
\fB\-\-iexclude\fP=[] \fB\-\-iexclude\fP=[]
@ -72,7 +76,7 @@ repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -84,7 +88,7 @@ repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -108,11 +112,11 @@ repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -120,15 +124,15 @@ repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-self-update.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -21,6 +20,11 @@ authenticity of the binary is verified using the GPG signature on the release
files. files.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -38,7 +42,7 @@ files.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -50,7 +54,7 @@ files.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -74,11 +78,11 @@ files.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -86,15 +90,15 @@ files.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

30
doc/man/restic-snapshots.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,7 +9,7 @@ restic\-snapshots \- List all snapshots
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic snapshots [snapshotID ...] [flags]\fP \fBrestic snapshots [flags] [snapshotID ...]\fP
.SH DESCRIPTION .SH DESCRIPTION
@ -18,6 +17,11 @@ restic\-snapshots \- List all snapshots
The "snapshots" command lists all snapshots stored in the repository. The "snapshots" command lists all snapshots stored in the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-c\fP, \fB\-\-compact\fP[=false] \fB\-c\fP, \fB\-\-compact\fP[=false]
@ -32,8 +36,8 @@ The "snapshots" command lists all snapshots stored in the repository.
help for snapshots help for snapshots
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR only consider snapshots for this \fB\fChost\fR (can be specified multiple times)
.PP .PP
\fB\-\-last\fP[=false] \fB\-\-last\fP[=false]
@ -55,7 +59,7 @@ The "snapshots" command lists all snapshots stored in the repository.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -67,7 +71,7 @@ The "snapshots" command lists all snapshots stored in the repository.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -91,11 +95,11 @@ The "snapshots" command lists all snapshots stored in the repository.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -103,15 +107,15 @@ The "snapshots" command lists all snapshots stored in the repository.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

55
doc/man/restic-stats.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -10,21 +9,22 @@ restic\-stats \- Scan the repository and show basic statistics
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrestic stats [flags] [snapshot\-ID]\fP \fBrestic stats [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The "stats" command walks one or all snapshots in a repository and The "stats" command walks one or multiple snapshots in a repository
accumulates statistics about the data stored therein. It reports on and accumulates statistics about the data stored therein. It reports
the number of unique files and their sizes, according to one of on the number of unique files and their sizes, according to one of
the counting modes as given by the \-\-mode flag. the counting modes as given by the \-\-mode flag.
.PP .PP
If no snapshot is specified, all snapshots will be considered. Some It operates on all snapshots matching the selection criteria or all
modes make more sense over just a single snapshot, while others snapshots if nothing is specified. The special snapshot ID "latest"
are useful across all snapshots, depending on what you are trying is also supported. Some modes make more sense over
to calculate. just a single snapshot, while others are useful across all snapshots,
depending on what you are trying to calculate.
.PP .PP
The modes are: The modes are:
@ -47,18 +47,31 @@ blobs\-per\-file: A combination of files\-by\-contents and raw\-data.
Refer to the online manual for more details about each mode. Refer to the online manual for more details about each mode.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
help for stats help for stats
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
filter latest snapshot by this hostname only consider snapshots with the given \fB\fChost\fR (can be specified multiple times)
.PP .PP
\fB\-\-mode\fP="restore\-size" \fB\-\-mode\fP="restore\-size"
counting mode: restore\-size (default), files\-by\-contents, blobs\-per\-file, or raw\-data counting mode: restore\-size (default), files\-by\-contents, blobs\-per\-file or raw\-data
.PP
\fB\-\-path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times)
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -68,7 +81,7 @@ Refer to the online manual for more details about each mode.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -80,7 +93,7 @@ Refer to the online manual for more details about each mode.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -104,11 +117,11 @@ Refer to the online manual for more details about each mode.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -116,15 +129,15 @@ Refer to the online manual for more details about each mode.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

28
doc/man/restic-tag.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -25,6 +24,11 @@ add tags to/remove tags from the existing set.
When no snapshot\-ID is given, all snapshots matching the host, tag and path filter criteria are modified. When no snapshot\-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-add\fP=[] \fB\-\-add\fP=[]
@ -35,8 +39,8 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
help for tag help for tag
.PP .PP
\fB\-H\fP, \fB\-\-host\fP="" \fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP .PP
\fB\-\-path\fP=[] \fB\-\-path\fP=[]
@ -62,7 +66,7 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -74,7 +78,7 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -98,11 +102,11 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -110,15 +114,15 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-unlock.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -18,6 +17,11 @@ restic\-unlock \- Remove locks other processes created
The "unlock" command removes stale locks that have been created by other restic processes. The "unlock" command removes stale locks that have been created by other restic processes.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -35,7 +39,7 @@ The "unlock" command removes stale locks that have been created by other restic
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -47,7 +51,7 @@ The "unlock" command removes stale locks that have been created by other restic
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -71,11 +75,11 @@ The "unlock" command removes stale locks that have been created by other restic
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -83,15 +87,15 @@ The "unlock" command removes stale locks that have been created by other restic
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

24
doc/man/restic-version.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -19,6 +18,11 @@ The "version" command prints detailed information about the build environment
and the version of this software. and the version of this software.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-h\fP, \fB\-\-help\fP[=false] \fB\-h\fP, \fB\-\-help\fP[=false]
@ -32,7 +36,7 @@ and the version of this software.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -44,7 +48,7 @@ and the version of this software.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -68,11 +72,11 @@ and the version of this software.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -80,15 +84,15 @@ and the version of this software.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO

21
doc/man/restic.1
View file

@ -1,7 +1,6 @@
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
.nh .nh
.ad l .TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
.SH NAME .SH NAME
.PP .PP
@ -26,7 +25,7 @@ directories in an encrypted repository stored on different backends.
.PP .PP
\fB\-\-cache\-dir\fP="" \fB\-\-cache\-dir\fP=""
set the cache directory. (default: use system default cache directory) set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP .PP
\fB\-\-cleanup\-cache\fP[=false] \fB\-\-cleanup\-cache\fP[=false]
@ -42,7 +41,7 @@ directories in an encrypted repository stored on different backends.
.PP .PP
\fB\-\-key\-hint\fP="" \fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT) \fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
.PP .PP
\fB\-\-limit\-download\fP=0 \fB\-\-limit\-download\fP=0
@ -66,11 +65,11 @@ directories in an encrypted repository stored on different backends.
.PP .PP
\fB\-\-password\-command\fP="" \fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND) shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
.PP .PP
\fB\-p\fP, \fB\-\-password\-file\fP="" \fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) \fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
.PP .PP
\fB\-q\fP, \fB\-\-quiet\fP[=false] \fB\-q\fP, \fB\-\-quiet\fP[=false]
@ -78,17 +77,17 @@ directories in an encrypted repository stored on different backends.
.PP .PP
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP .PP
\fB\-\-tls\-client\-cert\fP="" \fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP .PP
\fB\-v\fP, \fB\-\-verbose\fP[=0] \fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR) be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\fBrestic\-backup(1)\fP, \fBrestic\-cache(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-diff(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-recover(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-self\-update(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-stats(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP \fBrestic\-backup(1)\fP, \fBrestic\-cache(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-copy(1)\fP, \fBrestic\-diff(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-recover(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-self\-update(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-stats(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP

833
doc/zsh-completion.zsh
View file

@ -1,20 +1,827 @@
#compdef restic #compdef _restic restic
function _restic {
local -a commands
_arguments -C \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'(-h --help)'{-h,--help}'[help for restic]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]' \
"1: :->cmnds" \
"*::arg:->args"
_arguments \
'1: :->level1' \
'2: :_files'
case $state in case $state in
level1) cmnds)
case $words[1] in commands=(
restic) "backup:Create a new backup of files and/or directories"
_arguments '1: :(backup cache cat check diff dump find forget generate help init key list ls migrate mount options prune rebuild-index recover restore self-update snapshots stats tag unlock version)' "cache:Operate on local cache directories"
;; "cat:Print internal objects to stdout"
*) "check:Check the repository for errors"
_arguments '*: :_files' "copy:Copy snapshots from one repository to another"
"diff:Show differences between two snapshots"
"dump:Print a backed-up file to stdout"
"find:Find a file, a directory or restic IDs"
"forget:Remove snapshots from the repository"
"generate:Generate manual pages and auto-completion files (bash, zsh)"
"help:Help about any command"
"init:Initialize a new repository"
"key:Manage keys (passwords)"
"list:List objects in the repository"
"ls:List files in a snapshot"
"migrate:Apply migrations"
"mount:Mount the repository"
"prune:Remove unneeded data from the repository"
"rebuild-index:Build a new index file"
"recover:Recover data from the repository"
"restore:Extract the data from a snapshot"
"self-update:Update the restic binary"
"snapshots:List all snapshots"
"stats:Scan the repository and show basic statistics"
"tag:Modify tags on snapshots"
"unlock:Remove locks other processes created"
"version:Print version information"
)
_describe "command" commands
;; ;;
esac esac
case "$words[1]" in
backup)
_restic_backup
;; ;;
*) cache)
_arguments '*: :_files' _restic_cache
;;
cat)
_restic_cat
;;
check)
_restic_check
;;
copy)
_restic_copy
;;
diff)
_restic_diff
;;
dump)
_restic_dump
;;
find)
_restic_find
;;
forget)
_restic_forget
;;
generate)
_restic_generate
;;
help)
_restic_help
;;
init)
_restic_init
;;
key)
_restic_key
;;
list)
_restic_list
;;
ls)
_restic_ls
;;
migrate)
_restic_migrate
;;
mount)
_restic_mount
;;
prune)
_restic_prune
;;
rebuild-index)
_restic_rebuild-index
;;
recover)
_restic_recover
;;
restore)
_restic_restore
;;
self-update)
_restic_self-update
;;
snapshots)
_restic_snapshots
;;
stats)
_restic_stats
;;
tag)
_restic_tag
;;
unlock)
_restic_unlock
;;
version)
_restic_version
;; ;;
esac esac
}
function _restic_backup {
_arguments \
'(*-e *--exclude)'{\*-e,\*--exclude}'[exclude a `pattern` (can be specified multiple times)]:' \
'--exclude-caches[excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard]' \
'*--exclude-file[read exclude patterns from a `file` (can be specified multiple times)]:' \
'*--exclude-if-present[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)]:' \
'--exclude-larger-than[max `size` of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)]:' \
'*--files-from[read the files to backup from `file` (can be combined with file args/can be specified multiple times)]:' \
'(-f --force)'{-f,--force}'[force re-reading the target files/directories (overrides the "parent" flag)]' \
'(-h --help)'{-h,--help}'[help for backup]' \
'(-H --host)'{-H,--host}'[set the `hostname` for the snapshot manually. To prevent an expensive rescan use the "parent" flag]:' \
'*--iexclude[same as --exclude `pattern` but ignores the casing of filenames]:' \
'*--iexclude-file[same as --exclude-file but ignores casing of `file`names in patterns]:' \
'--ignore-inode[ignore inode number changes when checking for modified files]' \
'(-x --one-file-system)'{-x,--one-file-system}'[exclude other file systems]' \
'--parent[use this parent `snapshot` (default: last snapshot in the repo that has the same target files/directories)]:' \
'--stdin[read backup from stdin]' \
'--stdin-filename[`filename` to use when reading from stdin]:' \
'*--tag[add a `tag` for the new snapshot (can be specified multiple times)]:' \
'--time[`time` of the backup (ex. '\''2012-11-01 22:08:41'\'') (default: now)]:' \
'--with-atime[store the atime for all files and directories]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_cache {
_arguments \
'--cleanup[remove old cache directories]' \
'(-h --help)'{-h,--help}'[help for cache]' \
'--max-age[max age in `days` for cache directories to be considered old]:' \
'--no-size[do not output the size of the cache directories]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_cat {
_arguments \
'(-h --help)'{-h,--help}'[help for cat]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_check {
_arguments \
'--check-unused[find unused blobs]' \
'(-h --help)'{-h,--help}'[help for check]' \
'--read-data[read all data blobs]' \
'--read-data-subset[read subset n of m data packs (format: `n/m`)]:' \
'--with-cache[use the cache]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_copy {
_arguments \
'(-h --help)'{-h,--help}'[help for copy]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this `host`, when no snapshot ID is given (can be specified multiple times)]:' \
'--key-hint2[key ID of key to try decrypting the destination repository first (default: $RESTIC_KEY_HINT2)]:' \
'--password-command2[shell `command` to obtain the destination repository password from (default: $RESTIC_PASSWORD_COMMAND2)]:' \
'--password-file2[`file` to read the destination repository password from (default: $RESTIC_PASSWORD_FILE2)]:' \
'*--path[only consider snapshots which include this (absolute) `path`, when no snapshot ID is given]:' \
'--repo2[destination repository to copy snapshots to (default: $RESTIC_REPOSITORY2)]:' \
'--tag[only consider snapshots which include this `taglist`, when no snapshot ID is given]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_diff {
_arguments \
'(-h --help)'{-h,--help}'[help for diff]' \
'--metadata[print changes in metadata]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_dump {
_arguments \
'(-h --help)'{-h,--help}'[help for dump]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)]:' \
'*--path[only consider snapshots which include this (absolute) `path` for snapshot ID "latest"]:' \
'--tag[only consider snapshots which include this `taglist` for snapshot ID "latest"]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_find {
_arguments \
'--blob[pattern is a blob-ID]' \
'(-h --help)'{-h,--help}'[help for find]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this `host`, when no snapshot ID is given (can be specified multiple times)]:' \
'(-i --ignore-case)'{-i,--ignore-case}'[ignore case for pattern]' \
'(-l --long)'{-l,--long}'[use a long listing format showing size and mode]' \
'(-N --newest)'{-N,--newest}'[newest modification date/time]:' \
'(-O --oldest)'{-O,--oldest}'[oldest modification date/time]:' \
'--pack[pattern is a pack-ID]' \
'*--path[only consider snapshots which include this (absolute) `path`, when no snapshot-ID is given]:' \
'--show-pack-id[display the pack-ID the blobs belong to (with --blob or --tree)]' \
'(*-s *--snapshot)'{\*-s,\*--snapshot}'[snapshot `id` to search in (can be given multiple times)]:' \
'--tag[only consider snapshots which include this `taglist`, when no snapshot-ID is given]:' \
'--tree[pattern is a tree-ID]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_forget {
_arguments \
'(-l --keep-last)'{-l,--keep-last}'[keep the last `n` snapshots]:' \
'(-H --keep-hourly)'{-H,--keep-hourly}'[keep the last `n` hourly snapshots]:' \
'(-d --keep-daily)'{-d,--keep-daily}'[keep the last `n` daily snapshots]:' \
'(-w --keep-weekly)'{-w,--keep-weekly}'[keep the last `n` weekly snapshots]:' \
'(-m --keep-monthly)'{-m,--keep-monthly}'[keep the last `n` monthly snapshots]:' \
'(-y --keep-yearly)'{-y,--keep-yearly}'[keep the last `n` yearly snapshots]:' \
'--keep-within[keep snapshots that are newer than `duration` (eg. 1y5m7d2h) relative to the latest snapshot]:' \
'--keep-tag[keep snapshots with this `taglist` (can be specified multiple times)]:' \
'*--host[only consider snapshots with the given `host` (can be specified multiple times)]:' \
'--tag[only consider snapshots which include this `taglist` in the format `tag[,tag,...]` (can be specified multiple times)]:' \
'*--path[only consider snapshots which include this (absolute) `path` (can be specified multiple times)]:' \
'(-c --compact)'{-c,--compact}'[use compact format]' \
'(-g --group-by)'{-g,--group-by}'[string for grouping snapshots by host,paths,tags]:' \
'(-n --dry-run)'{-n,--dry-run}'[do not delete anything, just print what would be done]' \
'--prune[automatically run the '\''prune'\'' command if snapshots have been removed]' \
'(-h --help)'{-h,--help}'[help for forget]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_generate {
_arguments \
'--bash-completion[write bash completion `file`]:' \
'(-h --help)'{-h,--help}'[help for generate]' \
'--man[write man pages to `directory`]:' \
'--zsh-completion[write zsh completion `file`]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_help {
_arguments \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_init {
_arguments \
'--copy-chunker-params[copy chunker parameters from the secondary repository (useful with the copy command)]' \
'(-h --help)'{-h,--help}'[help for init]' \
'--key-hint2[key ID of key to try decrypting the secondary repository first (default: $RESTIC_KEY_HINT2)]:' \
'--password-command2[shell `command` to obtain the secondary repository password from (default: $RESTIC_PASSWORD_COMMAND2)]:' \
'--password-file2[`file` to read the secondary repository password from (default: $RESTIC_PASSWORD_FILE2)]:' \
'--repo2[secondary repository to copy chunker parameters from (default: $RESTIC_REPOSITORY2)]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_key {
_arguments \
'(-h --help)'{-h,--help}'[help for key]' \
'--host[the hostname for new keys]:' \
'--new-password-file[`file` from which to read the new password]:' \
'--user[the username for new keys]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_list {
_arguments \
'(-h --help)'{-h,--help}'[help for list]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_ls {
_arguments \
'(-h --help)'{-h,--help}'[help for ls]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this `host`, when no snapshot ID is given (can be specified multiple times)]:' \
'(-l --long)'{-l,--long}'[use a long listing format showing size and mode]' \
'*--path[only consider snapshots which include this (absolute) `path`, when no snapshot ID is given]:' \
'--recursive[include files in subfolders of the listed directories]' \
'--tag[only consider snapshots which include this `taglist`, when no snapshot ID is given]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_migrate {
_arguments \
'(-f --force)'{-f,--force}'[apply a migration a second time]' \
'(-h --help)'{-h,--help}'[help for migrate]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_mount {
_arguments \
'--allow-other[allow other users to access the data in the mounted directory]' \
'(-h --help)'{-h,--help}'[help for mount]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this host (can be specified multiple times)]:' \
'--no-default-permissions[for '\''allow-other'\'', ignore Unix permissions and allow users to read all snapshot files]' \
'--owner-root[use '\''root'\'' as the owner of files and dirs]' \
'*--path[only consider snapshots which include this (absolute) `path`]:' \
'--snapshot-template[set `template` to use for snapshot dirs]:' \
'--tag[only consider snapshots which include this `taglist`]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_prune {
_arguments \
'(-h --help)'{-h,--help}'[help for prune]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_rebuild-index {
_arguments \
'(-h --help)'{-h,--help}'[help for rebuild-index]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_recover {
_arguments \
'(-h --help)'{-h,--help}'[help for recover]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_restore {
_arguments \
'(*-e *--exclude)'{\*-e,\*--exclude}'[exclude a `pattern` (can be specified multiple times)]:' \
'(-h --help)'{-h,--help}'[help for restore]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)]:' \
'*--iexclude[same as `--exclude` but ignores the casing of filenames]:' \
'*--iinclude[same as `--include` but ignores the casing of filenames]:' \
'(*-i *--include)'{\*-i,\*--include}'[include a `pattern`, exclude everything else (can be specified multiple times)]:' \
'*--path[only consider snapshots which include this (absolute) `path` for snapshot ID "latest"]:' \
'--tag[only consider snapshots which include this `taglist` for snapshot ID "latest"]:' \
'(-t --target)'{-t,--target}'[directory to extract data to]:' \
'--verify[verify restored files content]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_self-update {
_arguments \
'(-h --help)'{-h,--help}'[help for self-update]' \
'--output[Save the downloaded file as `filename` (default: running binary itself)]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_snapshots {
_arguments \
'(-c --compact)'{-c,--compact}'[use compact format]' \
'(-g --group-by)'{-g,--group-by}'[string for grouping snapshots by host,paths,tags]:' \
'(-h --help)'{-h,--help}'[help for snapshots]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this `host` (can be specified multiple times)]:' \
'--last[only show the last snapshot for each host and path]' \
'*--path[only consider snapshots for this `path` (can be specified multiple times)]:' \
'--tag[only consider snapshots which include this `taglist` (can be specified multiple times)]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_stats {
_arguments \
'(-h --help)'{-h,--help}'[help for stats]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots with the given `host` (can be specified multiple times)]:' \
'--mode[counting mode: restore-size (default), files-by-contents, blobs-per-file or raw-data]:' \
'*--path[only consider snapshots which include this (absolute) `path` (can be specified multiple times)]:' \
'--tag[only consider snapshots which include this `taglist` in the format `tag[,tag,...]` (can be specified multiple times)]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_tag {
_arguments \
'*--add[`tag` which will be added to the existing tags (can be given multiple times)]:' \
'(-h --help)'{-h,--help}'[help for tag]' \
'(*-H *--host)'{\*-H,\*--host}'[only consider snapshots for this `host`, when no snapshot ID is given (can be specified multiple times)]:' \
'*--path[only consider snapshots which include this (absolute) `path`, when no snapshot-ID is given]:' \
'*--remove[`tag` which will be removed from the existing tags (can be given multiple times)]:' \
'*--set[`tag` which will replace the existing tags (can be given multiple times)]:' \
'--tag[only consider snapshots which include this `taglist`, when no snapshot-ID is given]:' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_unlock {
_arguments \
'(-h --help)'{-h,--help}'[help for unlock]' \
'--remove-all[remove all locks, even non-stale ones]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}
function _restic_version {
_arguments \
'(-h --help)'{-h,--help}'[help for version]' \
'*--cacert[`file` to load root certificates from (default: use system certificates)]:' \
'--cache-dir[set the cache `directory`. (default: use system default cache directory)]:' \
'--cleanup-cache[auto remove old cache directories]' \
'--json[set output mode to JSON for commands that support it]' \
'--key-hint[`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)]:' \
'--limit-download[limits downloads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--limit-upload[limits uploads to a maximum rate in KiB/s. (default: unlimited)]:' \
'--no-cache[do not use a local cache]' \
'--no-lock[do not lock the repo, this allows some operations on read-only repos]' \
'(*-o *--option)'{\*-o,\*--option}'[set extended option (`key=value`, can be specified multiple times)]:' \
'--password-command[shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)]:' \
'(-p --password-file)'{-p,--password-file}'[`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)]:' \
'(-q --quiet)'{-q,--quiet}'[do not output comprehensive progress report]' \
'(-r --repo)'{-r,--repo}'[`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)]:' \
'--tls-client-cert[path to a `file` containing PEM encoded TLS client certificate and private key]:' \
'(-v --verbose)'{-v,--verbose}'[be verbose (specify --verbose multiple times or level --verbose=`n`)]'
}