Update manpages and auto-completion

This commit is contained in:
Alexander Neumann 2022-03-26 20:09:59 +01:00
parent b567c08e80
commit a53a4a23fd
28 changed files with 155 additions and 10 deletions

View File

@ -367,6 +367,10 @@ _restic_backup()
flags_with_completion=()
flags_completion=()
flags+=("--dry-run")
flags+=("-n")
local_nonpersistent_flags+=("--dry-run")
local_nonpersistent_flags+=("-n")
flags+=("--exclude=")
two_word_flags+=("--exclude")
two_word_flags+=("-e")
@ -454,6 +458,7 @@ _restic_backup()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -519,6 +524,7 @@ _restic_cache()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -576,6 +582,7 @@ _restic_cat()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -643,6 +650,7 @@ _restic_check()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -734,6 +742,7 @@ _restic_copy()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -793,6 +802,7 @@ _restic_diff()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -870,6 +880,7 @@ _restic_dump()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -975,6 +986,7 @@ _restic_find()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1134,6 +1146,7 @@ _restic_forget()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1207,6 +1220,7 @@ _restic_generate()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1260,6 +1274,7 @@ _restic_help()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1340,6 +1355,7 @@ _restic_init()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1409,6 +1425,7 @@ _restic_key()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1466,6 +1483,7 @@ _restic_list()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1543,6 +1561,7 @@ _restic_ls()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1604,6 +1623,7 @@ _restic_migrate()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1685,6 +1705,7 @@ _restic_mount()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1756,6 +1777,7 @@ _restic_prune()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1815,6 +1837,7 @@ _restic_rebuild-index()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1872,6 +1895,7 @@ _restic_recover()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -1971,6 +1995,7 @@ _restic_restore()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2032,6 +2057,7 @@ _restic_self-update()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2117,6 +2143,7 @@ _restic_snapshots()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2192,6 +2219,7 @@ _restic_stats()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2275,6 +2303,7 @@ _restic_tag()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2334,6 +2363,7 @@ _restic_unlock()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2391,6 +2421,7 @@ _restic_version()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")
@ -2475,6 +2506,7 @@ _restic_root_command()
flags+=("-h")
local_nonpersistent_flags+=("--help")
local_nonpersistent_flags+=("-h")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
two_word_flags+=("--key-hint")

View File

@ -25,6 +25,10 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
.SH OPTIONS
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
do not upload or write any data, just show what would be done
.PP
\fB\-e\fP, \fB\-\-exclude\fP=[]
exclude a \fB\fCpattern\fR (can be specified multiple times)
@ -91,7 +95,7 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
.PP
\fB\-\-parent\fP=""
use this parent \fB\fCsnapshot\fR (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, and is not newer than the snapshot time)
.PP
\fB\-\-stdin\fP[=false]
@ -127,6 +131,10 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -52,6 +52,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -40,6 +40,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -41,7 +41,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
.PP
\fB\-\-read\-data\-subset\fP=""
read a \fB\fCsubset\fR of data packs, specified as 'n/t' for specific subset or either 'x%' or 'x.y%' for random subset
read a \fB\fCsubset\fR of data packs, specified as 'n/t' for specific part, or either 'x%' or 'x.y%' or a size in bytes with suffixes k/K, m/M, g/G, t/T for a random subset
.PP
\fB\-\-with\-cache\fP[=false]
@ -61,6 +61,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -81,6 +81,10 @@ new destination repository using the "init" command.
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -60,6 +60,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -63,6 +63,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -85,6 +85,10 @@ It can also be used to search for restic blobs or trees for troubleshooting.
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -15,8 +15,9 @@ restic\-forget \- Remove snapshots from the repository
.PP
The "forget" command removes snapshots according to a policy. Please note that
this command really only deletes the snapshot object in the repository, which
is a reference to data stored there. In order to remove this (now unreferenced)
data after 'forget' was run successfully, see the 'prune' command.
is a reference to data stored there. In order to remove the unreferenced data
after "forget" was run successfully, see the "prune" command. Please also read
the documentation for "forget" to learn about important security considerations.
.SH EXIT STATUS
@ -135,6 +136,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -57,6 +57,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -64,6 +64,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -52,6 +52,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -40,6 +40,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -43,7 +43,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
.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)
only consider snapshots for this \fB\fChost\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB\-l\fP, \fB\-\-long\fP[=false]
@ -51,7 +51,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
.PP
\fB\-\-path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot ID is given
only consider snapshots which include this (absolute) \fB\fCpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB\-\-recursive\fP[=false]
@ -59,7 +59,7 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot ID is given
only consider snapshots which include this \fB\fCtaglist\fR, when snapshot ID "latest" is given (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -75,6 +75,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -45,6 +45,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -100,6 +100,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -57,6 +57,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -45,6 +45,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-recover \- Recover data from the repository
restic\-recover \- Recover data from the repository not referenced by snapshots
.SH SYNOPSIS
@ -14,8 +14,8 @@ restic\-recover \- Recover data from the repository
.SH DESCRIPTION
.PP
The "recover" command builds a new snapshot from all directories it can find in
the raw data of the repository. It can be used if, for example, a snapshot has
been removed by accident with "forget".
the raw data of the repository which are not referenced in an existing snapshot.
It can be used if, for example, a snapshot has been removed by accident with "forget".
.SH EXIT STATUS
@ -42,6 +42,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -81,6 +81,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -47,6 +47,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -64,6 +64,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -86,6 +86,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -71,6 +71,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -44,6 +44,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -41,6 +41,10 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e
\fB\-\-cleanup\-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it

View File

@ -34,6 +34,10 @@ directories in an encrypted repository stored on different backends.
\fB\-h\fP, \fB\-\-help\fP[=false]
help for restic
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it