alexvanin/restic
1
0
Fork 0
forked from TrueCloudLab/restic
Code Pull requests Activity

Update manpages and auto-completion

Browse source
This commit is contained in:
Alexander Neumann 2018-02-17 20:27:28 +01:00
parent 1463a7aaaa
commit 3c08f956a3
23 changed files with 148 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/bash-completion.sh
View file

@ -287,6 +287,7 @@ _restic_backup()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -323,6 +324,7 @@ _restic_cat()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -365,6 +367,7 @@ _restic_check()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -403,6 +406,7 @@ _restic_diff()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -446,6 +450,7 @@ _restic_dump()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -504,6 +509,7 @@ _restic_find()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -579,6 +585,7 @@ _restic_forget()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -621,6 +628,7 @@ _restic_generate()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -657,6 +665,7 @@ _restic_init()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -693,6 +702,7 @@ _restic_key()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -729,6 +739,7 @@ _restic_list()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -775,6 +786,7 @@ _restic_ls()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -814,6 +826,7 @@ _restic_migrate()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -845,6 +858,8 @@ _restic_mount()
local_nonpersistent_flags+=("--owner-root") local_nonpersistent_flags+=("--owner-root")
flags+=("--path=") flags+=("--path=")
local_nonpersistent_flags+=("--path=") local_nonpersistent_flags+=("--path=")
flags+=("--snapshot-template=")
local_nonpersistent_flags+=("--snapshot-template=")
flags+=("--tag=") flags+=("--tag=")
local_nonpersistent_flags+=("--tag=") local_nonpersistent_flags+=("--tag=")
flags+=("--cacert=") flags+=("--cacert=")
@ -863,6 +878,7 @@ _restic_mount()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -899,6 +915,7 @@ _restic_prune()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -935,6 +952,7 @@ _restic_rebuild-index()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -987,6 +1005,7 @@ _restic_restore()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -1035,6 +1054,7 @@ _restic_snapshots()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -1084,6 +1104,7 @@ _restic_tag()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -1122,6 +1143,7 @@ _restic_unlock()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -1158,6 +1180,7 @@ _restic_version()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()
@ -1215,6 +1238,7 @@ _restic()
flags+=("-q") flags+=("-q")
flags+=("--repo=") flags+=("--repo=")
two_word_flags+=("-r") two_word_flags+=("-r")
flags+=("--tls-client-cert=")
must_have_one_flag=() must_have_one_flag=()
must_have_one_noun=() must_have_one_noun=()

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

@ -130,6 +130,10 @@ given as the arguments.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -73,6 +73,10 @@ The "cat" command is used to print internal objects to stdout.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -90,6 +90,10 @@ repository and not use a local cache.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -86,6 +86,10 @@ T The type was changed, e.g. a file was made a symlink
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -90,6 +90,10 @@ repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -106,6 +106,10 @@ repo.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -136,6 +136,10 @@ data after 'forget' was run successfully, see the 'prune' command.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -86,6 +86,10 @@ and the auto\-completion files for bash and zsh).
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -73,6 +73,10 @@ The "init" command initializes a new repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -73,6 +73,10 @@ The "key" command manages keys (passwords) for accessing the repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -73,6 +73,10 @@ The "list" command allows listing objects in the repository based on type.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -92,6 +92,10 @@ The special snapshot\-ID "latest" can be used to list files and directories of t
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -78,6 +78,10 @@ name is explicitly given, a list of migrations that can be applied is printed.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -19,6 +19,38 @@ The "mount" command mounts the repository via fuse to a directory. This is a
read\-only mount. read\-only mount.
.SH Snapshot Directories
.PP
If you need a different template for all directories that contain snapshots,
you can pass a template via \-\-snapshot\-template. Example without colons:
.PP
.RS
.nf
\-\-snapshot\-template "2006\-01\-02\_15\-04\-05"
.fi
.RE
.PP
You need to specify a sample format for exactly the following timestamp:
.PP
.RS
.nf
Mon Jan 2 15:04:05 \-0700 MST 2006
.fi
.RE
.PP
For details please see the documentation for time.Format() at:
\[la]https://godoc.org/time#Time.Format\[ra]
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\-\-allow\-other\fP[=false] \fB\-\-allow\-other\fP[=false]
@ -44,6 +76,10 @@ read\-only mount.
\fB\-\-path\fP=[] \fB\-\-path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR only consider snapshots which include this (absolute) \fB\fCpath\fR
.PP
\fB\-\-snapshot\-template\fP="2006\-01\-02T15:04:05Z07:00"
set \fB\fCtemplate\fR to use for snapshot dirs
.PP .PP
\fB\-\-tag\fP=[] \fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR only consider snapshots which include this \fB\fCtaglist\fR
@ -98,6 +134,10 @@ read\-only mount.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -74,6 +74,10 @@ referenced and therefore not needed any more.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -74,6 +74,10 @@ repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -102,6 +102,10 @@ repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -93,6 +93,10 @@ The "snapshots" command lists all snapshots stored in the repository.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -104,6 +104,10 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -77,6 +77,10 @@ The "unlock" command removes stale locks that have been created by other restic
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

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

@ -74,6 +74,10 @@ and the version of this software.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP

4
doc/man/restic.1
View file

@ -72,6 +72,10 @@ directories in an encrypted repository stored on different backends.
\fB\-r\fP, \fB\-\-repo\fP="" \fB\-r\fP, \fB\-\-repo\fP=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY) repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
.SH SEE ALSO .SH SEE ALSO
.PP .PP