From c5300a2c56c7206b4062abd3bde438e02d4e64e8 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Thu, 5 Nov 2020 09:41:35 +0100 Subject: [PATCH] Update manpages and auto-completion --- doc/bash-completion.sh | 135 +++++++++++++----------------- doc/man/restic-backup.1 | 80 +++++++++--------- doc/man/restic-cache.1 | 49 ++++++----- doc/man/restic-cat.1 | 43 +++++----- doc/man/restic-check.1 | 51 +++++++----- doc/man/restic-copy.1 | 57 +++++++------ doc/man/restic-diff.1 | 45 +++++----- doc/man/restic-dump.1 | 49 ++++++----- doc/man/restic-find.1 | 67 ++++++++------- doc/man/restic-forget.1 | 73 ++++++++-------- doc/man/restic-generate.1 | 49 ++++++----- doc/man/restic-init.1 | 53 ++++++------ doc/man/restic-key.1 | 49 ++++++----- doc/man/restic-list.1 | 43 +++++----- doc/man/restic-ls.1 | 53 ++++++------ doc/man/restic-migrate.1 | 45 +++++----- doc/man/restic-mount.1 | 60 +++++++------ doc/man/restic-prune.1 | 43 +++++----- doc/man/restic-rebuild-index.1 | 43 +++++----- doc/man/restic-recover.1 | 45 +++++----- doc/man/restic-restore.1 | 61 +++++++------- doc/man/restic-self-update.1 | 45 +++++----- doc/man/restic-snapshots.1 | 55 ++++++------ doc/man/restic-stats.1 | 51 +++++++----- doc/man/restic-tag.1 | 55 ++++++------ doc/man/restic-unlock.1 | 45 +++++----- doc/man/restic-version.1 | 43 +++++----- doc/man/restic.1 | 43 +++++----- doc/zsh-completion.zsh | 148 ++++++++++++++++++++------------- 29 files changed, 912 insertions(+), 766 deletions(-) diff --git a/doc/bash-completion.sh b/doc/bash-completion.sh index 112b31bd6..321caa124 100644 --- a/doc/bash-completion.sh +++ b/doc/bash-completion.sh @@ -36,71 +36,9 @@ __restic_contains_word() return 1 } -__restic_handle_go_custom_completion() -{ - __restic_debug "${FUNCNAME[0]}: cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}" - - local out requestComp lastParam lastChar comp directive args - - # Prepare the command to request completions for the program. - # Calling ${words[0]} instead of directly restic allows to handle aliases - args=("${words[@]:1}") - requestComp="${words[0]} __completeNoDesc ${args[*]}" - - lastParam=${words[$((${#words[@]}-1))]} - lastChar=${lastParam:$((${#lastParam}-1)):1} - __restic_debug "${FUNCNAME[0]}: lastParam ${lastParam}, lastChar ${lastChar}" - - if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then - # If the last parameter is complete (there is a space following it) - # We add an extra empty parameter so we can indicate this to the go method. - __restic_debug "${FUNCNAME[0]}: Adding extra empty parameter" - requestComp="${requestComp} \"\"" - fi - - __restic_debug "${FUNCNAME[0]}: calling ${requestComp}" - # Use eval to handle any environment variables and such - out=$(eval "${requestComp}" 2>/dev/null) - - # Extract the directive integer at the very end of the output following a colon (:) - directive=${out##*:} - # Remove the directive - out=${out%:*} - if [ "${directive}" = "${out}" ]; then - # There is not directive specified - directive=0 - fi - __restic_debug "${FUNCNAME[0]}: the completion directive is: ${directive}" - __restic_debug "${FUNCNAME[0]}: the completions are: ${out[*]}" - - if [ $((directive & 1)) -ne 0 ]; then - # Error code. No completion. - __restic_debug "${FUNCNAME[0]}: received error from custom completion go code" - return - else - if [ $((directive & 2)) -ne 0 ]; then - if [[ $(type -t compopt) = "builtin" ]]; then - __restic_debug "${FUNCNAME[0]}: activating no space" - compopt -o nospace - fi - fi - if [ $((directive & 4)) -ne 0 ]; then - if [[ $(type -t compopt) = "builtin" ]]; then - __restic_debug "${FUNCNAME[0]}: activating no file completion" - compopt +o default - fi - fi - - while IFS='' read -r comp; do - COMPREPLY+=("$comp") - done < <(compgen -W "${out[*]}" -- "$cur") - fi -} - __restic_handle_reply() { __restic_debug "${FUNCNAME[0]}" - local comp case $cur in -*) if [[ $(type -t compopt) = "builtin" ]]; then @@ -112,9 +50,7 @@ __restic_handle_reply() else allflags=("${flags[*]} ${two_word_flags[*]}") fi - while IFS='' read -r comp; do - COMPREPLY+=("$comp") - done < <(compgen -W "${allflags[*]}" -- "$cur") + COMPREPLY=( $(compgen -W "${allflags[*]}" -- "$cur") ) if [[ $(type -t compopt) = "builtin" ]]; then [[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace fi @@ -160,22 +96,14 @@ __restic_handle_reply() completions=("${commands[@]}") if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then completions=("${must_have_one_noun[@]}") - elif [[ -n "${has_completion_function}" ]]; then - # if a go completion function is provided, defer to that function - completions=() - __restic_handle_go_custom_completion fi if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then completions+=("${must_have_one_flag[@]}") fi - while IFS='' read -r comp; do - COMPREPLY+=("$comp") - done < <(compgen -W "${completions[*]}" -- "$cur") + COMPREPLY=( $(compgen -W "${completions[*]}" -- "$cur") ) if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then - while IFS='' read -r comp; do - COMPREPLY+=("$comp") - done < <(compgen -W "${noun_aliases[*]}" -- "$cur") + COMPREPLY=( $(compgen -W "${noun_aliases[*]}" -- "$cur") ) fi if [[ ${#COMPREPLY[@]} -eq 0 ]]; then @@ -210,7 +138,7 @@ __restic_handle_filename_extension_flag() __restic_handle_subdirs_in_dir_flag() { local dir="$1" - pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return + pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 } __restic_handle_flag() @@ -418,6 +346,8 @@ _restic_backup() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -479,6 +409,8 @@ _restic_cache() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -533,6 +465,8 @@ _restic_cat() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -596,6 +530,8 @@ _restic_check() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -672,6 +608,8 @@ _restic_copy() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -728,6 +666,8 @@ _restic_diff() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -792,6 +732,8 @@ _restic_dump() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -882,6 +824,8 @@ _restic_find() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -987,6 +931,8 @@ _restic_forget() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1050,6 +996,8 @@ _restic_generate() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1118,6 +1066,8 @@ _restic_init() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1181,6 +1131,8 @@ _restic_key() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1235,6 +1187,8 @@ _restic_list() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1304,6 +1258,8 @@ _restic_ls() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1361,6 +1317,8 @@ _restic_migrate() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1434,6 +1392,8 @@ _restic_mount() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1488,6 +1448,8 @@ _restic_prune() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1542,6 +1504,8 @@ _restic_rebuild-index() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1596,6 +1560,8 @@ _restic_recover() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1680,6 +1646,8 @@ _restic_restore() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1737,6 +1705,8 @@ _restic_self-update() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1810,6 +1780,8 @@ _restic_snapshots() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1877,6 +1849,8 @@ _restic_stats() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -1950,6 +1924,8 @@ _restic_tag() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -2006,6 +1982,8 @@ _restic_unlock() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -2060,6 +2038,8 @@ _restic_version() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -2140,6 +2120,8 @@ _restic_root_command() flags+=("--repo=") two_word_flags+=("--repo") two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") flags+=("--tls-client-cert=") two_word_flags+=("--tls-client-cert") flags+=("--verbose") @@ -2170,7 +2152,6 @@ __start_restic() local commands=("restic") local must_have_one_flag=() local must_have_one_noun=() - local has_completion_function local last_command local nouns=() diff --git a/doc/man/restic-backup.1 b/doc/man/restic-backup.1 index c6051099c..4cfcf32c7 100644 --- a/doc/man/restic-backup.1 +++ b/doc/man/restic-backup.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -28,145 +29,150 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea .SH OPTIONS .PP \fB\-e\fP, \fB\-\-exclude\fP=[] - exclude a \fB\fCpattern\fR (can be specified multiple times) + exclude a \fB\fCpattern\fR (can be specified multiple times) .PP \fB\-\-exclude\-caches\fP[=false] - excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard + excludes cache directories that are marked with a CACHEDIR.TAG file. See +\[la]https://bford.info/cachedir/\[ra] for the Cache Directory Tagging Standard .PP \fB\-\-exclude\-file\fP=[] - read exclude patterns from a \fB\fCfile\fR (can be specified multiple times) + read exclude patterns from a \fB\fCfile\fR (can be specified multiple times) .PP \fB\-\-exclude\-if\-present\fP=[] - 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) + 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) + max \fB\fCsize\fR of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T) .PP \fB\-\-files\-from\fP=[] - read the files to backup from \fB\fCfile\fR (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 \fB\-f\fP, \fB\-\-force\fP[=false] - force re\-reading the target files/directories (overrides the "parent" flag) + force re\-reading the target files/directories (overrides the "parent" flag) .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for backup + help for backup .PP \fB\-H\fP, \fB\-\-host\fP="" - set the \fB\fChostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag + set the \fB\fChostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag .PP \fB\-\-iexclude\fP=[] - same as \-\-exclude \fB\fCpattern\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 + same as \-\-exclude\-file but ignores casing of \fB\fCfile\fRnames in patterns .PP \fB\-\-ignore\-inode\fP[=false] - ignore inode number changes when checking for modified files + ignore inode number changes when checking for modified files .PP \fB\-x\fP, \fB\-\-one\-file\-system\fP[=false] - exclude other file systems + exclude other file systems .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) .PP \fB\-\-stdin\fP[=false] - read backup from stdin + read backup from stdin .PP \fB\-\-stdin\-filename\fP="stdin" - \fB\fCfilename\fR to use when reading from stdin + \fB\fCfilename\fR to use when reading from stdin .PP \fB\-\-tag\fP=[] - add a \fB\fCtag\fR for the new snapshot (can be specified multiple times) + add a \fB\fCtag\fR for the new snapshot (can be specified multiple times) .PP \fB\-\-time\fP="" - \fB\fCtime\fR 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 \fB\-\-with\-atime\fP[=false] - store the atime for all files and directories + store the atime for all files and directories .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-cache.1 b/doc/man/restic-cache.1 index 99feb8b1d..03d5fbda9 100644 --- a/doc/man/restic-cache.1 +++ b/doc/man/restic-cache.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,85 +26,89 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-cleanup\fP[=false] - remove old cache directories + remove old cache directories .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for cache + help for cache .PP \fB\-\-max\-age\fP=30 - max age in \fB\fCdays\fR for cache directories to be considered old + max age in \fB\fCdays\fR for cache directories to be considered old .PP \fB\-\-no\-size\fP[=false] - do not output the size of the cache directories + do not output the size of the cache directories .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-cat.1 b/doc/man/restic-cat.1 index 08d26ee00..2c204e2e7 100644 --- a/doc/man/restic-cat.1 +++ b/doc/man/restic-cat.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,73 +26,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for cat + help for cat .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-check.1 b/doc/man/restic-check.1 index 75d2193bd..bc787b4ec 100644 --- a/doc/man/restic-check.1 +++ b/doc/man/restic-check.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -30,89 +31,93 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-check\-unused\fP[=false] - find unused blobs + find unused blobs .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for check + help for check .PP \fB\-\-read\-data\fP[=false] - read all data blobs + read all data blobs .PP \fB\-\-read\-data\-subset\fP="" - read subset n of m data packs (format: \fB\fCn/m\fR) + read subset n of m data packs (format: \fB\fCn/m\fR) .PP \fB\-\-with\-cache\fP[=false] - use the cache + use the cache .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-copy.1 b/doc/man/restic-copy.1 index a7e41fccb..ecef43352 100644 --- a/doc/man/restic-copy.1 +++ b/doc/man/restic-copy.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,101 +26,105 @@ option when initializing a new destination repository using the "init" command. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for copy + 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) + 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) + 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) + 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) + \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 + 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) + destination \fB\fCrepository\fR 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 + 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) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-diff.1 b/doc/man/restic-diff.1 index 880aec32a..c0e513d19 100644 --- a/doc/man/restic-diff.1 +++ b/doc/man/restic-diff.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -41,77 +42,81 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for diff + help for diff .PP \fB\-\-metadata\fP[=false] - print changes in metadata + print changes in metadata .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-dump.1 b/doc/man/restic-dump.1 index 2493fa8f6..4d3f9cf94 100644 --- a/doc/man/restic-dump.1 +++ b/doc/man/restic-dump.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -32,85 +33,89 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for dump + help for dump .PP \fB\-H\fP, \fB\-\-host\fP=[] - only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times) + only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times) .PP \fB\-\-path\fP=[] - only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest" + only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest" .PP \fB\-\-tag\fP=[] - only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest" + only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest" .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-find.1 b/doc/man/restic-find.1 index a0205ba6f..97ccdeedb 100644 --- a/doc/man/restic-find.1 +++ b/doc/man/restic-find.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -22,121 +23,125 @@ It can also be used to search for restic blobs or trees for troubleshooting. .SH OPTIONS .PP \fB\-\-blob\fP[=false] - pattern is a blob\-ID + pattern is a blob\-ID .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for find + help for find .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 no snapshot ID is given (can be specified multiple times) .PP \fB\-i\fP, \fB\-\-ignore\-case\fP[=false] - ignore case for pattern + ignore case for pattern .PP \fB\-l\fP, \fB\-\-long\fP[=false] - use a long listing format showing size and mode + use a long listing format showing size and mode .PP \fB\-N\fP, \fB\-\-newest\fP="" - newest modification date/time + newest modification date/time .PP \fB\-O\fP, \fB\-\-oldest\fP="" - oldest modification date/time + oldest modification date/time .PP \fB\-\-pack\fP[=false] - pattern is a pack\-ID + pattern is a pack\-ID .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 no snapshot\-ID is given .PP \fB\-\-show\-pack\-id\fP[=false] - display the pack\-ID the blobs belong to (with \-\-blob or \-\-tree) + display the pack\-ID the blobs belong to (with \-\-blob or \-\-tree) .PP \fB\-s\fP, \fB\-\-snapshot\fP=[] - snapshot \fB\fCid\fR to search in (can be given multiple times) + snapshot \fB\fCid\fR to search in (can be given multiple times) .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 no snapshot\-ID is given .PP \fB\-\-tree\fP[=false] - pattern is a tree\-ID + pattern is a tree\-ID .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH EXAMPLE diff --git a/doc/man/restic-forget.1 b/doc/man/restic-forget.1 index 208af2518..f74b95e44 100644 --- a/doc/man/restic-forget.1 +++ b/doc/man/restic-forget.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -28,133 +29,137 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-l\fP, \fB\-\-keep\-last\fP=0 - keep the last \fB\fCn\fR snapshots + keep the last \fB\fCn\fR snapshots .PP \fB\-H\fP, \fB\-\-keep\-hourly\fP=0 - keep the last \fB\fCn\fR hourly snapshots + keep the last \fB\fCn\fR hourly snapshots .PP \fB\-d\fP, \fB\-\-keep\-daily\fP=0 - keep the last \fB\fCn\fR daily snapshots + keep the last \fB\fCn\fR daily snapshots .PP \fB\-w\fP, \fB\-\-keep\-weekly\fP=0 - keep the last \fB\fCn\fR weekly snapshots + keep the last \fB\fCn\fR weekly snapshots .PP \fB\-m\fP, \fB\-\-keep\-monthly\fP=0 - keep the last \fB\fCn\fR monthly snapshots + keep the last \fB\fCn\fR monthly snapshots .PP \fB\-y\fP, \fB\-\-keep\-yearly\fP=0 - keep the last \fB\fCn\fR yearly snapshots + keep the last \fB\fCn\fR yearly snapshots .PP \fB\-\-keep\-within\fP= - keep snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot + keep snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot .PP \fB\-\-keep\-tag\fP=[] - 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 \fB\-\-host\fP=[] - only consider snapshots with the given \fB\fChost\fR (can be specified multiple times) + only consider snapshots with the given \fB\fChost\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) + only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times) .PP \fB\-\-path\fP=[] - only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times) + only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times) .PP \fB\-c\fP, \fB\-\-compact\fP[=false] - use compact format + use compact output format .PP \fB\-g\fP, \fB\-\-group\-by\fP="host,paths" - string for grouping snapshots by host,paths,tags + string for grouping snapshots by host,paths,tags .PP \fB\-n\fP, \fB\-\-dry\-run\fP[=false] - do not delete anything, just print what would be done + do not delete anything, just print what would be done .PP \fB\-\-prune\fP[=false] - automatically run the 'prune' command if snapshots have been removed + automatically run the 'prune' command if snapshots have been removed .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for forget + help for forget .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-generate.1 b/doc/man/restic-generate.1 index 99aef55e1..c65e1062d 100644 --- a/doc/man/restic-generate.1 +++ b/doc/man/restic-generate.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -26,85 +27,89 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-bash\-completion\fP="" - write bash completion \fB\fCfile\fR + write bash completion \fB\fCfile\fR .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for generate + help for generate .PP \fB\-\-man\fP="" - write man pages to \fB\fCdirectory\fR + write man pages to \fB\fCdirectory\fR .PP \fB\-\-zsh\-completion\fP="" - write zsh completion \fB\fCfile\fR + write zsh completion \fB\fCfile\fR .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-init.1 b/doc/man/restic-init.1 index 24d4d8618..d6256a658 100644 --- a/doc/man/restic-init.1 +++ b/doc/man/restic-init.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,93 +26,97 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-copy\-chunker\-params\fP[=false] - copy chunker parameters from the secondary repository (useful with the copy command) + copy chunker parameters from the secondary repository (useful with the copy command) .PP \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) + 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) + 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) + \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) + secondary \fB\fCrepository\fR to copy chunker parameters from (default: $RESTIC\_REPOSITORY2) .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-key.1 b/doc/man/restic-key.1 index 4be707a59..6ac3b91d0 100644 --- a/doc/man/restic-key.1 +++ b/doc/man/restic-key.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,85 +26,89 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for key + help for key .PP \fB\-\-host\fP="" - the hostname for new keys + the hostname for new keys .PP \fB\-\-new\-password\-file\fP="" - \fB\fCfile\fR from which to read the new password + \fB\fCfile\fR from which to read the new password .PP \fB\-\-user\fP="" - the username for new keys + the username for new keys .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-list.1 b/doc/man/restic-list.1 index de1f96049..a33d7db69 100644 --- a/doc/man/restic-list.1 +++ b/doc/man/restic-list.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,73 +26,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for list + help for list .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-ls.1 b/doc/man/restic-ls.1 index 5a9f7a269..9024487eb 100644 --- a/doc/man/restic-ls.1 +++ b/doc/man/restic-ls.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -40,93 +41,97 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for ls + help for ls .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 no snapshot ID is given (can be specified multiple times) .PP \fB\-l\fP, \fB\-\-long\fP[=false] - use a long listing format showing size and mode + use a long listing format showing size and mode .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 no snapshot ID is given .PP \fB\-\-recursive\fP[=false] - include files in subfolders of the listed directories + include files in subfolders of the listed directories .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 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) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-migrate.1 b/doc/man/restic-migrate.1 index 3f80a130c..5e7c8acee 100644 --- a/doc/man/restic-migrate.1 +++ b/doc/man/restic-migrate.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -26,77 +27,81 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-f\fP, \fB\-\-force\fP[=false] - apply a migration a second time + apply a migration a second time .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for migrate + help for migrate .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-mount.1 b/doc/man/restic-mount.1 index 7c0f7b7d6..06e524070 100644 --- a/doc/man/restic-mount.1 +++ b/doc/man/restic-mount.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -46,7 +47,8 @@ Mon Jan 2 15:04:05 \-0700 MST 2006 .PP 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 @@ -57,101 +59,105 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-allow\-other\fP[=false] - allow other users to access the data in the mounted directory + allow other users to access the data in the mounted directory .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for mount + help for mount .PP \fB\-H\fP, \fB\-\-host\fP=[] - only consider snapshots for this host (can be specified multiple times) + only consider snapshots for this host (can be specified multiple times) .PP \fB\-\-no\-default\-permissions\fP[=false] - for 'allow\-other', ignore Unix permissions and allow users to read all snapshot files + for 'allow\-other', ignore Unix permissions and allow users to read all snapshot files .PP \fB\-\-owner\-root\fP[=false] - use 'root' as the owner of files and dirs + use 'root' as the owner of files and dirs .PP \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 + set \fB\fCtemplate\fR to use for snapshot dirs .PP \fB\-\-tag\fP=[] - only consider snapshots which include this \fB\fCtaglist\fR + only consider snapshots which include this \fB\fCtaglist\fR .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-prune.1 b/doc/man/restic-prune.1 index 518b52b44..16ba09601 100644 --- a/doc/man/restic-prune.1 +++ b/doc/man/restic-prune.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -26,73 +27,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for prune + help for prune .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-rebuild-index.1 b/doc/man/restic-rebuild-index.1 index aebf24c71..024bd5ade 100644 --- a/doc/man/restic-rebuild-index.1 +++ b/doc/man/restic-rebuild-index.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -26,73 +27,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for rebuild\-index + help for rebuild\-index .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-recover.1 b/doc/man/restic-recover.1 index bcb619a5a..d174f96fd 100644 --- a/doc/man/restic-recover.1 +++ b/doc/man/restic-recover.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -14,7 +15,7 @@ restic\-recover \- Recover data from the repository .SH DESCRIPTION .PP -The "recover" command build a new snapshot from all directories it can find in +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". @@ -27,73 +28,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for recover + help for recover .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-restore.1 b/doc/man/restic-restore.1 index 7a92a2077..a254a2f16 100644 --- a/doc/man/restic-restore.1 +++ b/doc/man/restic-restore.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -30,109 +31,113 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-e\fP, \fB\-\-exclude\fP=[] - exclude a \fB\fCpattern\fR (can be specified multiple times) + exclude a \fB\fCpattern\fR (can be specified multiple times) .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for restore + help for restore .PP \fB\-H\fP, \fB\-\-host\fP=[] - only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times) + only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times) .PP \fB\-\-iexclude\fP=[] - same as \fB\fC\-\-exclude\fR but ignores the casing of filenames + same as \fB\fC\-\-exclude\fR but ignores the casing of filenames .PP \fB\-\-iinclude\fP=[] - same as \fB\fC\-\-include\fR but ignores the casing of filenames + same as \fB\fC\-\-include\fR but ignores the casing of filenames .PP \fB\-i\fP, \fB\-\-include\fP=[] - include a \fB\fCpattern\fR, exclude everything else (can be specified multiple times) + include a \fB\fCpattern\fR, exclude everything else (can be specified multiple times) .PP \fB\-\-path\fP=[] - only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest" + only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest" .PP \fB\-\-tag\fP=[] - only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest" + only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest" .PP \fB\-t\fP, \fB\-\-target\fP="" - directory to extract data to + directory to extract data to .PP \fB\-\-verify\fP[=false] - verify restored files content + verify restored files content .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-self-update.1 b/doc/man/restic-self-update.1 index 79869095e..9f55325be 100644 --- a/doc/man/restic-self-update.1 +++ b/doc/man/restic-self-update.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -28,77 +29,81 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for self\-update + help for self\-update .PP \fB\-\-output\fP="" - Save the downloaded file as \fB\fCfilename\fR (default: running binary itself) + Save the downloaded file as \fB\fCfilename\fR (default: running binary itself) .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-snapshots.1 b/doc/man/restic-snapshots.1 index aba0d7886..0ed19ef19 100644 --- a/doc/man/restic-snapshots.1 +++ b/doc/man/restic-snapshots.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,97 +26,101 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-c\fP, \fB\-\-compact\fP[=false] - use compact format + use compact output format .PP \fB\-g\fP, \fB\-\-group\-by\fP="" - string for grouping snapshots by host,paths,tags + string for grouping snapshots by host,paths,tags .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for snapshots + help for snapshots .PP \fB\-H\fP, \fB\-\-host\fP=[] - only consider snapshots for this \fB\fChost\fR (can be specified multiple times) + only consider snapshots for this \fB\fChost\fR (can be specified multiple times) .PP \fB\-\-last\fP[=false] - only show the last snapshot for each host and path + only show the last snapshot for each host and path .PP \fB\-\-path\fP=[] - only consider snapshots for this \fB\fCpath\fR (can be specified multiple times) + only consider snapshots for this \fB\fCpath\fR (can be specified multiple times) .PP \fB\-\-tag\fP=[] - only consider snapshots which include this \fB\fCtaglist\fR (can be specified multiple times) + only consider snapshots which include this \fB\fCtaglist\fR (can be specified multiple times) .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-stats.1 b/doc/man/restic-stats.1 index af4bcebdc..45b2c7ea3 100644 --- a/doc/man/restic-stats.1 +++ b/doc/man/restic-stats.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -55,89 +56,93 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for stats + help for stats .PP \fB\-H\fP, \fB\-\-host\fP=[] - only consider snapshots with the given \fB\fChost\fR (can be specified multiple times) + only consider snapshots with the given \fB\fChost\fR (can be specified multiple times) .PP \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) + 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) + 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 .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-tag.1 b/doc/man/restic-tag.1 index 1146fac64..a07195a62 100644 --- a/doc/man/restic-tag.1 +++ b/doc/man/restic-tag.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -32,97 +33,101 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-\-add\fP=[] - \fB\fCtag\fR which will be added to the existing tags (can be given multiple times) + \fB\fCtag\fR which will be added to the existing tags (can be given multiple times) .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for tag + help for tag .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 no snapshot ID is given (can be specified multiple times) .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 no snapshot\-ID is given .PP \fB\-\-remove\fP=[] - \fB\fCtag\fR which will be removed from the existing tags (can be given multiple times) + \fB\fCtag\fR which will be removed from the existing tags (can be given multiple times) .PP \fB\-\-set\fP=[] - \fB\fCtag\fR which will replace the existing tags (can be given multiple times) + \fB\fCtag\fR which will replace the existing tags (can be given multiple times) .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 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) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-unlock.1 b/doc/man/restic-unlock.1 index fbbac4748..790ba6972 100644 --- a/doc/man/restic-unlock.1 +++ b/doc/man/restic-unlock.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -25,77 +26,81 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for unlock + help for unlock .PP \fB\-\-remove\-all\fP[=false] - remove all locks, even non\-stale ones + remove all locks, even non\-stale ones .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic-version.1 b/doc/man/restic-version.1 index 5238643a9..64b99fc3a 100644 --- a/doc/man/restic-version.1 +++ b/doc/man/restic-version.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -26,73 +27,77 @@ Exit status is 0 if the command was successful, and non\-zero if there was any e .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for version + help for version .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/man/restic.1 b/doc/man/restic.1 index 98d9e73f8..42ddc26d6 100644 --- a/doc/man/restic.1 +++ b/doc/man/restic.1 @@ -1,6 +1,7 @@ +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh -.TH restic backup(1)Jan 2017 -generated by \fB\fCrestic generate\fR +.ad l + .SH NAME .PP @@ -21,71 +22,75 @@ directories in an encrypted repository stored on different backends. .SH OPTIONS .PP \fB\-\-cacert\fP=[] - \fB\fCfile\fR to load root certificates from (default: use system certificates) + \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) + set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory) .PP \fB\-\-cleanup\-cache\fP[=false] - auto remove old cache directories + auto remove old cache directories .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for restic + help for restic .PP \fB\-\-json\fP[=false] - set output mode to JSON for commands that support it + 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) + \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) + 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) + limits uploads to a maximum rate in KiB/s. (default: unlimited) .PP \fB\-\-no\-cache\fP[=false] - do not use a local cache + 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 + do not lock the repository, this allows some operations on read\-only repositories .PP \fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) + 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) + 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) + \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 + 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) + \fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY) + +.PP +\fB\-\-repository\-file\fP="" + \fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE) .PP \fB\-\-tls\-client\-cert\fP="" - path to a \fB\fCfile\fR 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 \fB\-v\fP, \fB\-\-verbose\fP[=0] - be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR) + be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3) .SH SEE ALSO diff --git a/doc/zsh-completion.zsh b/doc/zsh-completion.zsh index 848acbd9c..2b2100d57 100644 --- a/doc/zsh-completion.zsh +++ b/doc/zsh-completion.zsh @@ -14,14 +14,15 @@ function _restic { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' \ + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' \ "1: :->cmnds" \ "*::arg:->args" @@ -174,14 +175,15 @@ function _restic_backup { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_cache { @@ -198,14 +200,15 @@ function _restic_cache { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_cat { @@ -219,14 +222,15 @@ function _restic_cat { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_check { @@ -244,14 +248,15 @@ function _restic_check { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_copy { @@ -262,7 +267,7 @@ function _restic_copy { '--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)]:' \ + '--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)]:' \ @@ -272,14 +277,15 @@ function _restic_copy { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_diff { @@ -294,14 +300,15 @@ function _restic_diff { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_dump { @@ -318,14 +325,15 @@ function _restic_dump { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_find { @@ -351,14 +359,15 @@ function _restic_find { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_forget { @@ -374,7 +383,7 @@ function _restic_forget { '*--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]' \ + '(-c --compact)'{-c,--compact}'[use compact output 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]' \ @@ -387,14 +396,15 @@ function _restic_forget { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_generate { @@ -411,14 +421,15 @@ function _restic_generate { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_help { @@ -431,14 +442,15 @@ function _restic_help { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_init { @@ -448,7 +460,7 @@ function _restic_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)]:' \ + '--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]' \ @@ -457,14 +469,15 @@ function _restic_init { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_key { @@ -481,14 +494,15 @@ function _restic_key { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_list { @@ -502,14 +516,15 @@ function _restic_list { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_ls { @@ -528,14 +543,15 @@ function _restic_ls { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_migrate { @@ -550,14 +566,15 @@ function _restic_migrate { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_mount { @@ -578,14 +595,15 @@ function _restic_mount { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_prune { @@ -599,14 +617,15 @@ function _restic_prune { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_rebuild-index { @@ -620,14 +639,15 @@ function _restic_rebuild-index { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_recover { @@ -641,14 +661,15 @@ function _restic_recover { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_restore { @@ -671,14 +692,15 @@ function _restic_restore { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_self-update { @@ -693,19 +715,20 @@ function _restic_self-update { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_snapshots { _arguments \ - '(-c --compact)'{-c,--compact}'[use compact format]' \ + '(-c --compact)'{-c,--compact}'[use compact output 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)]:' \ @@ -720,14 +743,15 @@ function _restic_snapshots { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_stats { @@ -745,14 +769,15 @@ function _restic_stats { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_tag { @@ -772,14 +797,15 @@ function _restic_tag { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_unlock { @@ -794,14 +820,15 @@ function _restic_unlock { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' } function _restic_version { @@ -815,13 +842,14 @@ function _restic_version { '--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]' \ + '--no-lock[do not lock the repository, this allows some operations on read-only repositories]' \ '(*-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)]:' \ + '--repository-file[`file` to read the repository location from (default: $RESTIC_REPOSITORY_FILE)]:' \ '--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`)]' + '(-v --verbose)'{-v,--verbose}'[be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 3)]' }