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

Update manpages and auto-completion

Browse source
This commit is contained in:
Alexander Neumann 2022-08-25 19:55:00 +02:00
parent 193c62dfc3
commit c1a5da56e3
30 changed files with 1515 additions and 1080 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

274
doc/bash-completion.sh
View file

@ -2,7 +2,7 @@
__restic_debug()
{
if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then
if [[ -n ${BASH_COMP_DEBUG_FILE:-} ]]; then
echo "$*" >> "${BASH_COMP_DEBUG_FILE}"
fi
}
@ -51,7 +51,8 @@ __restic_handle_go_custom_completion()
# 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[*]}"
# Disable ActiveHelp which is not supported for bash completion v1
requestComp="RESTIC_ACTIVE_HELP=0 ${words[0]} __completeNoDesc ${args[*]}"
lastParam=${words[$((${#words[@]}-1))]}
lastChar=${lastParam:$((${#lastParam}-1)):1}
@ -77,7 +78,7 @@ __restic_handle_go_custom_completion()
directive=0
fi
__restic_debug "${FUNCNAME[0]}: the completion directive is: ${directive}"
__restic_debug "${FUNCNAME[0]}: the completions are: ${out[*]}"
__restic_debug "${FUNCNAME[0]}: the completions are: ${out}"
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
# Error code. No completion.
@ -103,7 +104,7 @@ __restic_handle_go_custom_completion()
local fullFilter filter filteringCmd
# Do not use quotes around the $out variable or else newline
# characters will be kept.
for filter in ${out[*]}; do
for filter in ${out}; do
fullFilter+="$filter|"
done
@ -112,9 +113,9 @@ __restic_handle_go_custom_completion()
$filteringCmd
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
# File completion for directories only
local subDir
local subdir
# Use printf to strip any trailing newline
subdir=$(printf "%s" "${out[0]}")
subdir=$(printf "%s" "${out}")
if [ -n "$subdir" ]; then
__restic_debug "Listing directories in $subdir"
__restic_handle_subdirs_in_dir_flag "$subdir"
@ -125,7 +126,7 @@ __restic_handle_go_custom_completion()
else
while IFS='' read -r comp; do
COMPREPLY+=("$comp")
done < <(compgen -W "${out[*]}" -- "$cur")
done < <(compgen -W "${out}" -- "$cur")
fi
}
@ -165,13 +166,19 @@ __restic_handle_reply()
PREFIX=""
cur="${cur#*=}"
${flags_completion[${index}]}
if [ -n "${ZSH_VERSION}" ]; then
if [ -n "${ZSH_VERSION:-}" ]; then
# zsh completion needs --flag= prefix
eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )"
fi
fi
fi
return 0;
if [[ -z "${flag_parsing_disabled}" ]]; then
# If flag parsing is enabled, we have completed the flags and can return.
# If flag parsing is disabled, we may not know all (or any) of the flags, so we fallthrough
# to possibly call handle_go_custom_completion.
return 0;
fi
;;
esac
@ -210,13 +217,13 @@ __restic_handle_reply()
fi
if [[ ${#COMPREPLY[@]} -eq 0 ]]; then
if declare -F __restic_custom_func >/dev/null; then
# try command name qualified custom func
__restic_custom_func
else
# otherwise fall back to unqualified for compatibility
declare -F __custom_func >/dev/null && __custom_func
fi
if declare -F __restic_custom_func >/dev/null; then
# try command name qualified custom func
__restic_custom_func
else
# otherwise fall back to unqualified for compatibility
declare -F __custom_func >/dev/null && __custom_func
fi
fi
# available in bash-completion >= 2, not always present on macOS
@ -250,7 +257,7 @@ __restic_handle_flag()
# if a command required a flag, and we found it, unset must_have_one_flag()
local flagname=${words[c]}
local flagvalue
local flagvalue=""
# if the word contained an =
if [[ ${words[c]} == *"="* ]]; then
flagvalue=${flagname#*=} # take in as flagvalue after the =
@ -269,7 +276,7 @@ __restic_handle_flag()
# keep flag value with flagname as flaghash
# flaghash variable is an associative array which is only supported in bash > 3.
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
if [ -n "${flagvalue}" ] ; then
flaghash[${flagname}]=${flagvalue}
elif [ -n "${words[ $((c+1)) ]}" ] ; then
@ -281,7 +288,7 @@ __restic_handle_flag()
# skip the argument to a two word flag
if [[ ${words[c]} != *"="* ]] && __restic_contains_word "${words[c]}" "${two_word_flags[@]}"; then
__restic_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
__restic_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
c=$((c+1))
# if we are looking for a flags value, don't show commands
if [[ $c -eq $cword ]]; then
@ -341,7 +348,7 @@ __restic_handle_word()
__restic_handle_command
elif __restic_contains_word "${words[c]}" "${command_aliases[@]}"; then
# aliashash variable is an associative array which is only supported in bash > 3.
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
words[c]=${aliashash[${words[c]}]}
__restic_handle_command
else
@ -458,6 +465,8 @@ _restic_backup()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -471,6 +480,8 @@ _restic_backup()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -524,6 +535,8 @@ _restic_cache()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -537,6 +550,8 @@ _restic_cache()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -582,6 +597,8 @@ _restic_cat()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -595,6 +612,8 @@ _restic_cat()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -631,8 +650,6 @@ _restic_check()
flags_with_completion=()
flags_completion=()
flags+=("--check-unused")
local_nonpersistent_flags+=("--check-unused")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@ -650,6 +667,8 @@ _restic_check()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -663,6 +682,8 @@ _restic_check()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -699,6 +720,26 @@ _restic_copy()
flags_with_completion=()
flags_completion=()
flags+=("--from-key-hint=")
two_word_flags+=("--from-key-hint")
local_nonpersistent_flags+=("--from-key-hint")
local_nonpersistent_flags+=("--from-key-hint=")
flags+=("--from-password-command=")
two_word_flags+=("--from-password-command")
local_nonpersistent_flags+=("--from-password-command")
local_nonpersistent_flags+=("--from-password-command=")
flags+=("--from-password-file=")
two_word_flags+=("--from-password-file")
local_nonpersistent_flags+=("--from-password-file")
local_nonpersistent_flags+=("--from-password-file=")
flags+=("--from-repo=")
two_word_flags+=("--from-repo")
local_nonpersistent_flags+=("--from-repo")
local_nonpersistent_flags+=("--from-repo=")
flags+=("--from-repository-file=")
two_word_flags+=("--from-repository-file")
local_nonpersistent_flags+=("--from-repository-file")
local_nonpersistent_flags+=("--from-repository-file=")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@ -709,30 +750,10 @@ _restic_copy()
local_nonpersistent_flags+=("--host")
local_nonpersistent_flags+=("--host=")
local_nonpersistent_flags+=("-H")
flags+=("--key-hint2=")
two_word_flags+=("--key-hint2")
local_nonpersistent_flags+=("--key-hint2")
local_nonpersistent_flags+=("--key-hint2=")
flags+=("--password-command2=")
two_word_flags+=("--password-command2")
local_nonpersistent_flags+=("--password-command2")
local_nonpersistent_flags+=("--password-command2=")
flags+=("--password-file2=")
two_word_flags+=("--password-file2")
local_nonpersistent_flags+=("--password-file2")
local_nonpersistent_flags+=("--password-file2=")
flags+=("--path=")
two_word_flags+=("--path")
local_nonpersistent_flags+=("--path")
local_nonpersistent_flags+=("--path=")
flags+=("--repo2=")
two_word_flags+=("--repo2")
local_nonpersistent_flags+=("--repo2")
local_nonpersistent_flags+=("--repo2=")
flags+=("--repository-file2=")
two_word_flags+=("--repository-file2")
local_nonpersistent_flags+=("--repository-file2")
local_nonpersistent_flags+=("--repository-file2=")
flags+=("--tag=")
two_word_flags+=("--tag")
local_nonpersistent_flags+=("--tag")
@ -742,6 +763,8 @@ _restic_copy()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -755,6 +778,8 @@ _restic_copy()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -802,6 +827,8 @@ _restic_diff()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -815,6 +842,8 @@ _restic_diff()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -880,6 +909,8 @@ _restic_dump()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -893,6 +924,8 @@ _restic_dump()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -986,6 +1019,8 @@ _restic_find()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -999,6 +1034,8 @@ _restic_find()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1137,6 +1174,10 @@ _restic_forget()
local_nonpersistent_flags+=("--max-repack-size=")
flags+=("--repack-cacheable-only")
local_nonpersistent_flags+=("--repack-cacheable-only")
flags+=("--repack-small")
local_nonpersistent_flags+=("--repack-small")
flags+=("--repack-uncompressed")
local_nonpersistent_flags+=("--repack-uncompressed")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@ -1146,6 +1187,8 @@ _restic_forget()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1159,6 +1202,8 @@ _restic_forget()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1220,6 +1265,8 @@ _restic_generate()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1233,6 +1280,8 @@ _restic_generate()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1274,6 +1323,8 @@ _restic_help()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1287,6 +1338,8 @@ _restic_help()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1326,35 +1379,41 @@ _restic_init()
flags+=("--copy-chunker-params")
local_nonpersistent_flags+=("--copy-chunker-params")
flags+=("--from-key-hint=")
two_word_flags+=("--from-key-hint")
local_nonpersistent_flags+=("--from-key-hint")
local_nonpersistent_flags+=("--from-key-hint=")
flags+=("--from-password-command=")
two_word_flags+=("--from-password-command")
local_nonpersistent_flags+=("--from-password-command")
local_nonpersistent_flags+=("--from-password-command=")
flags+=("--from-password-file=")
two_word_flags+=("--from-password-file")
local_nonpersistent_flags+=("--from-password-file")
local_nonpersistent_flags+=("--from-password-file=")
flags+=("--from-repo=")
two_word_flags+=("--from-repo")
local_nonpersistent_flags+=("--from-repo")
local_nonpersistent_flags+=("--from-repo=")
flags+=("--from-repository-file=")
two_word_flags+=("--from-repository-file")
local_nonpersistent_flags+=("--from-repository-file")
local_nonpersistent_flags+=("--from-repository-file=")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
local_nonpersistent_flags+=("-h")
flags+=("--key-hint2=")
two_word_flags+=("--key-hint2")
local_nonpersistent_flags+=("--key-hint2")
local_nonpersistent_flags+=("--key-hint2=")
flags+=("--password-command2=")
two_word_flags+=("--password-command2")
local_nonpersistent_flags+=("--password-command2")
local_nonpersistent_flags+=("--password-command2=")
flags+=("--password-file2=")
two_word_flags+=("--password-file2")
local_nonpersistent_flags+=("--password-file2")
local_nonpersistent_flags+=("--password-file2=")
flags+=("--repo2=")
two_word_flags+=("--repo2")
local_nonpersistent_flags+=("--repo2")
local_nonpersistent_flags+=("--repo2=")
flags+=("--repository-file2=")
two_word_flags+=("--repository-file2")
local_nonpersistent_flags+=("--repository-file2")
local_nonpersistent_flags+=("--repository-file2=")
flags+=("--repository-version=")
two_word_flags+=("--repository-version")
local_nonpersistent_flags+=("--repository-version")
local_nonpersistent_flags+=("--repository-version=")
flags+=("--cacert=")
two_word_flags+=("--cacert")
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1368,6 +1427,8 @@ _restic_init()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1425,6 +1486,8 @@ _restic_key()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1438,6 +1501,8 @@ _restic_key()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1483,6 +1548,8 @@ _restic_list()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1496,6 +1563,8 @@ _restic_list()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1561,6 +1630,8 @@ _restic_ls()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1574,6 +1645,8 @@ _restic_ls()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1623,6 +1696,8 @@ _restic_migrate()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1636,6 +1711,8 @@ _restic_migrate()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1692,19 +1769,25 @@ _restic_mount()
two_word_flags+=("--path")
local_nonpersistent_flags+=("--path")
local_nonpersistent_flags+=("--path=")
flags+=("--snapshot-template=")
two_word_flags+=("--snapshot-template")
local_nonpersistent_flags+=("--snapshot-template")
local_nonpersistent_flags+=("--snapshot-template=")
flags+=("--path-template=")
two_word_flags+=("--path-template")
local_nonpersistent_flags+=("--path-template")
local_nonpersistent_flags+=("--path-template=")
flags+=("--tag=")
two_word_flags+=("--tag")
local_nonpersistent_flags+=("--tag")
local_nonpersistent_flags+=("--tag=")
flags+=("--time-template=")
two_word_flags+=("--time-template")
local_nonpersistent_flags+=("--time-template")
local_nonpersistent_flags+=("--time-template=")
flags+=("--cacert=")
two_word_flags+=("--cacert")
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1718,6 +1801,8 @@ _restic_mount()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1772,11 +1857,21 @@ _restic_prune()
local_nonpersistent_flags+=("--max-unused=")
flags+=("--repack-cacheable-only")
local_nonpersistent_flags+=("--repack-cacheable-only")
flags+=("--repack-small")
local_nonpersistent_flags+=("--repack-small")
flags+=("--repack-uncompressed")
local_nonpersistent_flags+=("--repack-uncompressed")
flags+=("--unsafe-recover-no-free-space=")
two_word_flags+=("--unsafe-recover-no-free-space")
local_nonpersistent_flags+=("--unsafe-recover-no-free-space")
local_nonpersistent_flags+=("--unsafe-recover-no-free-space=")
flags+=("--cacert=")
two_word_flags+=("--cacert")
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1790,6 +1885,8 @@ _restic_prune()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1837,6 +1934,8 @@ _restic_rebuild-index()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1850,6 +1949,8 @@ _restic_rebuild-index()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1895,6 +1996,8 @@ _restic_recover()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -1908,6 +2011,8 @@ _restic_recover()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -1995,6 +2100,8 @@ _restic_restore()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2008,6 +2115,8 @@ _restic_restore()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2057,6 +2166,8 @@ _restic_self-update()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2070,6 +2181,8 @@ _restic_self-update()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2143,6 +2256,8 @@ _restic_snapshots()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2156,6 +2271,8 @@ _restic_snapshots()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2219,6 +2336,8 @@ _restic_stats()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2232,6 +2351,8 @@ _restic_stats()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2303,6 +2424,8 @@ _restic_tag()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2316,6 +2439,8 @@ _restic_tag()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2363,6 +2488,8 @@ _restic_unlock()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2376,6 +2503,8 @@ _restic_unlock()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2421,6 +2550,8 @@ _restic_version()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--insecure-tls")
flags+=("--json")
flags+=("--key-hint=")
@ -2434,6 +2565,8 @@ _restic_version()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2502,6 +2635,8 @@ _restic_root_command()
flags+=("--cache-dir=")
two_word_flags+=("--cache-dir")
flags+=("--cleanup-cache")
flags+=("--compression=")
two_word_flags+=("--compression")
flags+=("--help")
flags+=("-h")
local_nonpersistent_flags+=("--help")
@ -2519,6 +2654,8 @@ _restic_root_command()
flags+=("--option=")
two_word_flags+=("--option")
two_word_flags+=("-o")
flags+=("--pack-size=")
two_word_flags+=("--pack-size")
flags+=("--password-command=")
two_word_flags+=("--password-command")
flags+=("--password-file=")
@ -2553,6 +2690,7 @@ __start_restic()
fi
local c=0
local flag_parsing_disabled=
local flags=()
local two_word_flags=()
local local_nonpersistent_flags=()
@ -2562,8 +2700,8 @@ __start_restic()
local command_aliases=()
local must_have_one_flag=()
local must_have_one_noun=()
local has_completion_function
local last_command
local has_completion_function=""
local last_command=""
local nouns=()
local noun_aliases=()

3
doc/fish-completion.fish
View file

@ -18,7 +18,8 @@ function __restic_perform_completion
__restic_debug "args: $args"
__restic_debug "last arg: $lastArg"
set -l requestComp "$args[1] __complete $args[2..-1] $lastArg"
# Disable ActiveHelp which is not supported for fish shell
set -l requestComp "RESTIC_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg"
__restic_debug "Calling $requestComp"
set -l results (eval $requestComp 2> /dev/null)

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

@ -3,12 +3,12 @@
.SH NAME
.PP
restic\-backup \- Create a new backup of files and/or directories
restic-backup - Create a new backup of files and/or directories
.SH SYNOPSIS
.PP
\fBrestic backup [flags] FILE/DIR [FILE/DIR] ...\fP
\fBrestic backup [flags] [FILE/DIR] ...\fP
.SH DESCRIPTION
@ -26,170 +26,178 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea
.SH OPTIONS
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
\fB-n\fP, \fB--dry-run\fP[=false]
do not upload or write any data, just show what would be done
.PP
\fB\-e\fP, \fB\-\-exclude\fP=[]
\fB-e\fP, \fB--exclude\fP=[]
exclude a \fB\fCpattern\fR (can be specified multiple times)
.PP
\fB\-\-exclude\-caches\fP[=false]
\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
.PP
\fB\-\-exclude\-file\fP=[]
\fB--exclude-file\fP=[]
read exclude patterns from a \fB\fCfile\fR (can be specified multiple times)
.PP
\fB\-\-exclude\-if\-present\fP=[]
\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)
.PP
\fB\-\-exclude\-larger\-than\fP=""
\fB--exclude-larger-than\fP=""
max \fB\fCsize\fR of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)
.PP
\fB\-\-files\-from\fP=[]
\fB--files-from\fP=[]
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
.PP
\fB\-\-files\-from\-raw\fP=[]
\fB--files-from-raw\fP=[]
read the files to backup from \fB\fCfile\fR (can be combined with file args; can be specified multiple times)
.PP
\fB\-\-files\-from\-verbatim\fP=[]
\fB--files-from-verbatim\fP=[]
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)
\fB-f\fP, \fB--force\fP[=false]
force re-reading the target files/directories (overrides the "parent" flag)
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for backup
.PP
\fB\-H\fP, \fB\-\-host\fP=""
\fB-H\fP, \fB--host\fP=""
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
\fB--iexclude\fP=[]
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
\fB--iexclude-file\fP=[]
same as --exclude-file but ignores casing of \fB\fCfile\fRnames in patterns
.PP
\fB\-\-ignore\-ctime\fP[=false]
\fB--ignore-ctime\fP[=false]
ignore ctime changes when checking for modified files
.PP
\fB\-\-ignore\-inode\fP[=false]
\fB--ignore-inode\fP[=false]
ignore inode number changes when checking for modified files
.PP
\fB\-x\fP, \fB\-\-one\-file\-system\fP[=false]
\fB-x\fP, \fB--one-file-system\fP[=false]
exclude other file systems, don't cross filesystem boundaries and subvolumes
.PP
\fB\-\-parent\fP=""
use this parent \fB\fCsnapshot\fR (default: last snapshot in the repo that has the same target files/directories, and is not newer than the snapshot time)
\fB--parent\fP=""
use this parent \fB\fCsnapshot\fR (default: last snapshot in the repository that has the same target files/directories, and is not newer than the snapshot time)
.PP
\fB\-\-stdin\fP[=false]
\fB--stdin\fP[=false]
read backup from stdin
.PP
\fB\-\-stdin\-filename\fP="stdin"
\fB--stdin-filename\fP="stdin"
\fB\fCfilename\fR to use when reading from stdin
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
add \fB\fCtags\fR for the new snapshot in the format \fB\fCtag[,tag,...]\fR (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--time\fP=""
\fB\fCtime\fR of the backup (ex. '2012-11-01 22:08:41') (default: now)
.PP
\fB\-\-with\-atime\fP[=false]
\fB--with-atime\fP[=false]
store the atime for all files and directories
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-cache \- Operate on local cache directories
restic-cache - Operate on local cache directories
.SH SYNOPSIS
@ -18,99 +18,107 @@ The "cache" command allows listing and cleaning local cache directories.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-cleanup\fP[=false]
\fB--cleanup\fP[=false]
remove old cache directories
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for cache
.PP
\fB\-\-max\-age\fP=30
\fB--max-age\fP=30
max age in \fB\fCdays\fR for cache directories to be considered old
.PP
\fB\-\-no\-size\fP[=false]
\fB--no-size\fP[=false]
do not output the size of the cache directories
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-cat \- Print internal objects to stdout
restic-cat - Print internal objects to stdout
.SH SYNOPSIS
@ -18,87 +18,95 @@ The "cat" command is used to print internal objects to stdout.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for cat
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-check \- Check the repository for errors
restic-check - Check the repository for errors
.SH SYNOPSIS
@ -23,103 +23,107 @@ repository and not use a local cache.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-check\-unused\fP[=false]
find unused blobs
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for check
.PP
\fB\-\-read\-data\fP[=false]
\fB--read-data\fP[=false]
read all data blobs
.PP
\fB\-\-read\-data\-subset\fP=""
\fB--read-data-subset\fP=""
read a \fB\fCsubset\fR of data packs, specified as 'n/t' for specific part, or either 'x%' or 'x.y%' or a size in bytes with suffixes k/K, m/M, g/G, t/T for a random subset
.PP
\fB\-\-with\-cache\fP[=false]
\fB--with-cache\fP[=false]
use the cache
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

114
doc/man/restic-copy.1
View file

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-copy \- Copy snapshots from one repository to another
restic-copy - Copy snapshots from one repository to another
.SH SYNOPSIS
@ -22,124 +22,132 @@ destination repositories. This /may incur higher bandwidth usage and costs/ than
expected during normal backup runs.
.PP
NOTE: The copying process does not re\-chunk files, which may break deduplication
NOTE: The copying process does not re-chunk files, which may break deduplication
between the files copied and files already stored in the destination repository.
This means that copied files, which existed in both the source and destination
repository, /may occupy up to twice their space/ in the destination repository.
This can be mitigated by the "\-\-copy\-chunker\-params" option when initializing a
This can be mitigated by the "--copy-chunker-params" option when initializing a
new destination repository using the "init" command.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB--from-key-hint\fP=""
key ID of key to try decrypting the source repository first (default: $RESTIC_FROM_KEY_HINT)
.PP
\fB--from-password-command\fP=""
shell \fB\fCcommand\fR to obtain the source repository password from (default: $RESTIC_FROM_PASSWORD_COMMAND)
.PP
\fB--from-password-file\fP=""
\fB\fCfile\fR to read the source repository password from (default: $RESTIC_FROM_PASSWORD_FILE)
.PP
\fB--from-repo\fP=""
source \fB\fCrepository\fR to copy snapshots from (default: $RESTIC_FROM_REPOSITORY)
.PP
\fB--from-repository-file\fP=""
\fB\fCfile\fR from which to read the source repository location to copy snapshots from (default: $RESTIC_FROM_REPOSITORY_FILE)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for copy
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP
\fB\-\-key\-hint2\fP=""
key ID of key to try decrypting the destination repository first (default: $RESTIC\_KEY\_HINT2)
.PP
\fB\-\-password\-command2\fP=""
shell \fB\fCcommand\fR to obtain the destination repository password from (default: $RESTIC\_PASSWORD\_COMMAND2)
.PP
\fB\-\-password\-file2\fP=""
\fB\fCfile\fR to read the destination repository password from (default: $RESTIC\_PASSWORD\_FILE2)
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot ID is given
.PP
\fB\-\-repo2\fP=""
destination \fB\fCrepository\fR to copy snapshots to (default: $RESTIC\_REPOSITORY2)
.PP
\fB\-\-repository\-file2\fP=""
\fB\fCfile\fR from which to read the destination repository location to copy snapshots to (default: $RESTIC\_REPOSITORY\_FILE2)
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot ID is given
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,12 +3,12 @@
.SH NAME
.PP
restic\-diff \- Show differences between two snapshots
restic-diff - Show differences between two snapshots
.SH SYNOPSIS
.PP
\fBrestic diff [flags] snapshot\-ID snapshot\-ID\fP
\fBrestic diff [flags] snapshot-ID snapshot-ID\fP
.SH DESCRIPTION
@ -21,7 +21,7 @@ directory:
.IP \(bu 2
+ The item was added
.IP \(bu 2
\- The item was removed
- The item was removed
.IP \(bu 2
U The metadata (access mode, timestamps, ...) for the item was updated
.IP \(bu 2
@ -34,91 +34,99 @@ T The type was changed, e.g. a file was made a symlink
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for diff
.PP
\fB\-\-metadata\fP[=false]
\fB--metadata\fP[=false]
print changes in metadata
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-dump \- Print a backed\-up file to stdout
restic-dump - Print a backed-up file to stdout
.SH SYNOPSIS
@ -25,103 +25,111 @@ repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-a\fP, \fB\-\-archive\fP="tar"
\fB-a\fP, \fB--archive\fP="tar"
set archive \fB\fCformat\fR as "tar" or "zip"
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for dump
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest"
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest"
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-find \- Find a file, a directory or restic IDs
restic-find - Find a file, a directory or restic IDs
.SH SYNOPSIS
@ -20,130 +20,138 @@ 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
\fB--blob\fP[=false]
pattern is a blob-ID
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for find
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
.PP
\fB\-i\fP, \fB\-\-ignore\-case\fP[=false]
\fB-i\fP, \fB--ignore-case\fP[=false]
ignore case for pattern
.PP
\fB\-l\fP, \fB\-\-long\fP[=false]
\fB-l\fP, \fB--long\fP[=false]
use a long listing format showing size and mode
.PP
\fB\-N\fP, \fB\-\-newest\fP=""
\fB-N\fP, \fB--newest\fP=""
newest modification date/time
.PP
\fB\-O\fP, \fB\-\-oldest\fP=""
\fB-O\fP, \fB--oldest\fP=""
oldest modification date/time
.PP
\fB\-\-pack\fP[=false]
pattern is a pack\-ID
\fB--pack\fP[=false]
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
\fB--path\fP=[]
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)
\fB--show-pack-id\fP[=false]
display the pack-ID the blobs belong to (with --blob or --tree)
.PP
\fB\-s\fP, \fB\-\-snapshot\fP=[]
\fB-s\fP, \fB--snapshot\fP=[]
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
\fB--tag\fP=[]
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
\fB--tree\fP[=false]
pattern is a tree-ID
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH EXAMPLE
@ -152,16 +160,16 @@ It can also be used to search for restic blobs or trees for troubleshooting.
.nf
restic find config.json
restic find \-\-json "*.yml" "*.json"
restic find \-\-json \-\-blob 420f620f b46ebe8a ddd38656
restic find \-\-show\-pack\-id \-\-blob 420f620f
restic find \-\-tree 577c2bc9 f81f2e22 a62827a9
restic find \-\-pack 025c1d06
restic find --json "*.yml" "*.json"
restic find --json --blob 420f620f b46ebe8a ddd38656
restic find --show-pack-id --blob 420f620f
restic find --tree 577c2bc9 f81f2e22 a62827a9
restic find --pack 025c1d06
EXIT STATUS
===========
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.fi

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-forget \- Remove snapshots from the repository
restic-forget - Remove snapshots from the repository
.SH SYNOPSIS
@ -13,188 +13,211 @@ restic\-forget \- Remove snapshots from the repository
.SH DESCRIPTION
.PP
The "forget" command removes snapshots according to a policy. Please note that
this command really only deletes the snapshot object in the repository, which
is a reference to data stored there. In order to remove the unreferenced data
after "forget" was run successfully, see the "prune" command. Please also read
the documentation for "forget" to learn about important security considerations.
The "forget" command removes snapshots according to a policy. All snapshots are
first divided into groups according to "--group-by", and after that the policy
specified by the "--keep-*" options is applied to each group individually.
.PP
Please note that this command really only deletes the snapshot object in the
repository, which is a reference to data stored there. In order to remove the
unreferenced data after "forget" was run successfully, see the "prune" command.
.PP
Please also read the documentation for "forget" to learn about some important
security considerations.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-l\fP, \fB\-\-keep\-last\fP=0
\fB-l\fP, \fB--keep-last\fP=0
keep the last \fB\fCn\fR snapshots
.PP
\fB\-H\fP, \fB\-\-keep\-hourly\fP=0
\fB-H\fP, \fB--keep-hourly\fP=0
keep the last \fB\fCn\fR hourly snapshots
.PP
\fB\-d\fP, \fB\-\-keep\-daily\fP=0
\fB-d\fP, \fB--keep-daily\fP=0
keep the last \fB\fCn\fR daily snapshots
.PP
\fB\-w\fP, \fB\-\-keep\-weekly\fP=0
\fB-w\fP, \fB--keep-weekly\fP=0
keep the last \fB\fCn\fR weekly snapshots
.PP
\fB\-m\fP, \fB\-\-keep\-monthly\fP=0
\fB-m\fP, \fB--keep-monthly\fP=0
keep the last \fB\fCn\fR monthly snapshots
.PP
\fB\-y\fP, \fB\-\-keep\-yearly\fP=0
\fB-y\fP, \fB--keep-yearly\fP=0
keep the last \fB\fCn\fR yearly snapshots
.PP
\fB\-\-keep\-within\fP=
\fB--keep-within\fP=
keep snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-within\-hourly\fP=
\fB--keep-within-hourly\fP=
keep hourly snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-within\-daily\fP=
\fB--keep-within-daily\fP=
keep daily snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-within\-weekly\fP=
\fB--keep-within-weekly\fP=
keep weekly snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-within\-monthly\fP=
\fB--keep-within-monthly\fP=
keep monthly snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-within\-yearly\fP=
\fB--keep-within-yearly\fP=
keep yearly snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
.PP
\fB\-\-keep\-tag\fP=[]
\fB--keep-tag\fP=[]
keep snapshots with this \fB\fCtaglist\fR (can be specified multiple times)
.PP
\fB\-\-host\fP=[]
\fB--host\fP=[]
only consider snapshots with the given \fB\fChost\fR (can be specified multiple times)
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
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=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times)
.PP
\fB\-c\fP, \fB\-\-compact\fP[=false]
\fB-c\fP, \fB--compact\fP[=false]
use compact output format
.PP
\fB\-g\fP, \fB\-\-group\-by\fP="host,paths"
string for grouping snapshots by host,paths,tags
\fB-g\fP, \fB--group-by\fP="host,paths"
\fB\fCgroup\fR snapshots by host, paths and/or tags, separated by comma (disable grouping with '')
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
\fB-n\fP, \fB--dry-run\fP[=false]
do not delete anything, just print what would be done
.PP
\fB\-\-prune\fP[=false]
\fB--prune\fP[=false]
automatically run the 'prune' command if snapshots have been removed
.PP
\fB\-\-max\-unused\fP="5%"
\fB--max-unused\fP="5%"
tolerate given \fB\fClimit\fR of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
.PP
\fB\-\-max\-repack\-size\fP=""
\fB--max-repack-size\fP=""
maximum \fB\fCsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
.PP
\fB\-\-repack\-cacheable\-only\fP[=false]
\fB--repack-cacheable-only\fP[=false]
only repack packs which are cacheable
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB--repack-small\fP[=false]
repack pack files below 80% of target pack size
.PP
\fB--repack-uncompressed\fP[=false]
repack all uncompressed data
.PP
\fB-h\fP, \fB--help\fP[=false]
help for forget
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-generate \- Generate manual pages and auto\-completion files (bash, fish, zsh)
restic-generate - Generate manual pages and auto-completion files (bash, fish, zsh)
.SH SYNOPSIS
@ -14,108 +14,116 @@ restic\-generate \- Generate manual pages and auto\-completion files (bash, fish
.SH DESCRIPTION
.PP
The "generate" command writes automatically generated files (like the man pages
and the auto\-completion files for bash, fish and zsh).
and the auto-completion files for bash, fish and zsh).
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-bash\-completion\fP=""
\fB--bash-completion\fP=""
write bash completion \fB\fCfile\fR
.PP
\fB\-\-fish\-completion\fP=""
\fB--fish-completion\fP=""
write fish completion \fB\fCfile\fR
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for generate
.PP
\fB\-\-man\fP=""
\fB--man\fP=""
write man pages to \fB\fCdirectory\fR
.PP
\fB\-\-zsh\-completion\fP=""
\fB--zsh-completion\fP=""
write zsh completion \fB\fCfile\fR
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-init \- Initialize a new repository
restic-init - Initialize a new repository
.SH SYNOPSIS
@ -18,111 +18,123 @@ The "init" command initializes a new repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-copy\-chunker\-params\fP[=false]
\fB--copy-chunker-params\fP[=false]
copy chunker parameters from the secondary repository (useful with the copy command)
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB--from-key-hint\fP=""
key ID of key to try decrypting the source repository first (default: $RESTIC_FROM_KEY_HINT)
.PP
\fB--from-password-command\fP=""
shell \fB\fCcommand\fR to obtain the source repository password from (default: $RESTIC_FROM_PASSWORD_COMMAND)
.PP
\fB--from-password-file\fP=""
\fB\fCfile\fR to read the source repository password from (default: $RESTIC_FROM_PASSWORD_FILE)
.PP
\fB--from-repo\fP=""
source \fB\fCrepository\fR to copy chunker parameters from (default: $RESTIC_FROM_REPOSITORY)
.PP
\fB--from-repository-file\fP=""
\fB\fCfile\fR from which to read the source repository location to copy chunker parameters from (default: $RESTIC_FROM_REPOSITORY_FILE)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for init
.PP
\fB\-\-key\-hint2\fP=""
key ID of key to try decrypting the secondary repository first (default: $RESTIC\_KEY\_HINT2)
.PP
\fB\-\-password\-command2\fP=""
shell \fB\fCcommand\fR to obtain the secondary repository password from (default: $RESTIC\_PASSWORD\_COMMAND2)
.PP
\fB\-\-password\-file2\fP=""
\fB\fCfile\fR to read the secondary repository password from (default: $RESTIC\_PASSWORD\_FILE2)
.PP
\fB\-\-repo2\fP=""
secondary \fB\fCrepository\fR to copy chunker parameters from (default: $RESTIC\_REPOSITORY2)
.PP
\fB\-\-repository\-file2\fP=""
\fB\fCfile\fR from which to read the secondary repository location to copy chunker parameters from (default: $RESTIC\_REPOSITORY\_FILE2)
\fB--repository-version\fP="stable"
repository format version to use, allowed values are a format version, 'latest' and 'stable'
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-key \- Manage keys (passwords)
restic-key - Manage keys (passwords)
.SH SYNOPSIS
@ -18,99 +18,107 @@ The "key" command manages keys (passwords) for accessing the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for key
.PP
\fB\-\-host\fP=""
\fB--host\fP=""
the hostname for new keys
.PP
\fB\-\-new\-password\-file\fP=""
\fB--new-password-file\fP=""
\fB\fCfile\fR from which to read the new password
.PP
\fB\-\-user\fP=""
\fB--user\fP=""
the username for new keys
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-list \- List objects in the repository
restic-list - List objects in the repository
.SH SYNOPSIS
@ -18,87 +18,95 @@ The "list" command allows listing objects in the repository based on type.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for list
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-ls \- List files in a snapshot
restic-ls - List files in a snapshot
.SH SYNOPSIS
@ -18,14 +18,14 @@ The "ls" command lists files and directories in a snapshot.
.PP
The special snapshot ID "latest" can be used to list files and
directories of the latest snapshot in the repository. The
\-\-host flag can be used in conjunction to select the latest
--host flag can be used in conjunction to select the latest
snapshot originating from a certain host only.
.PP
File listings can optionally be filtered by directories. Any
positional arguments after the snapshot ID are interpreted as
absolute directory paths, and only files inside those directories
will be listed. If the \-\-recursive flag is used, then the filter
will be listed. If the --recursive flag is used, then the filter
will allow traversing into matching directories' subfolders.
Any directory paths specified must be absolute (starting with
a path separator); paths use the forward slash '/' as separator.
@ -33,107 +33,115 @@ a path separator); paths use the forward slash '/' as separator.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for ls
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB\-l\fP, \fB\-\-long\fP[=false]
\fB-l\fP, \fB--long\fP[=false]
use a long listing format showing size and mode
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
.PP
\fB\-\-recursive\fP[=false]
\fB--recursive\fP[=false]
include files in subfolders of the listed directories
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when snapshot ID "latest" is given (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,107 +3,116 @@
.SH NAME
.PP
restic\-migrate \- Apply migrations
restic-migrate - Apply migrations
.SH SYNOPSIS
.PP
\fBrestic migrate [flags] [name]\fP
\fBrestic migrate [flags] [migration name] [...]\fP
.SH DESCRIPTION
.PP
The "migrate" command applies migrations to a repository. When no migration
name is explicitly given, a list of migrations that can be applied is printed.
The "migrate" command checks which migrations can be applied for a repository
and prints a list with available migration names. If one or more migration
names are specified, these migrations are applied.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-force\fP[=false]
\fB-f\fP, \fB--force\fP[=false]
apply a migration a second time
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for migrate
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-mount \- Mount the repository
restic-mount - Mount the repository
.SH SYNOPSIS
@ -14,19 +14,23 @@ restic\-mount \- Mount the repository
.SH DESCRIPTION
.PP
The "mount" command mounts the repository via fuse to a directory. This is a
read\-only mount.
read-only mount.
.SH Snapshot Directories
.PP
If you need a different template for all directories that contain snapshots,
you can pass a template via \-\-snapshot\-template. Example without colons:
If you need a different template for directories that contain snapshots,
you can pass a time template via --time-template and path templates via
--path-template.
.PP
Example time template without colons:
.PP
.RS
.nf
\-\-snapshot\-template "2006\-01\-02\_15\-04\-05"
--time-template "2006-01-02_15-04-05"
.fi
.RE
@ -38,7 +42,7 @@ You need to specify a sample format for exactly the following timestamp:
.RS
.nf
Mon Jan 2 15:04:05 \-0700 MST 2006
Mon Jan 2 15:04:05 -0700 MST 2006
.fi
.RE
@ -47,118 +51,146 @@ Mon Jan 2 15:04:05 \-0700 MST 2006
For details please see the documentation for time.Format() at:
https://godoc.org/time#Time.Format
.PP
For path templates, you can use the following patterns which will be replaced:
%i by short snapshot ID
%I by long snapshot ID
%u by username
%h by hostname
%t by tags
%T by timestamp as specified by --time-template
.PP
The default path templates are:
"ids/%i"
"snapshots/%T"
"hosts/%h/%T"
"tags/%t/%T"
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-allow\-other\fP[=false]
\fB--allow-other\fP[=false]
allow other users to access the data in the mounted directory
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for mount
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
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
\fB--no-default-permissions\fP[=false]
for 'allow-other', ignore Unix permissions and allow users to read all snapshot files
.PP
\fB\-\-owner\-root\fP[=false]
\fB--owner-root\fP[=false]
use 'root' as the owner of files and dirs
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
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
\fB--path-template\fP=[]
set \fB\fCtemplate\fR for path names (can be specified multiple times)
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR
.PP
\fB--time-template\fP="2006-01-02T15:04:05Z07:00"
set \fB\fCtemplate\fR to use for times
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-prune \- Remove unneeded data from the repository
restic-prune - Remove unneeded data from the repository
.SH SYNOPSIS
@ -19,103 +19,123 @@ referenced and therefore not needed any more.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
\fB-n\fP, \fB--dry-run\fP[=false]
do not modify the repository, just print what would be done
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for prune
.PP
\fB\-\-max\-repack\-size\fP=""
\fB--max-repack-size\fP=""
maximum \fB\fCsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
.PP
\fB\-\-max\-unused\fP="5%"
\fB--max-unused\fP="5%"
tolerate given \fB\fClimit\fR of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
.PP
\fB\-\-repack\-cacheable\-only\fP[=false]
\fB--repack-cacheable-only\fP[=false]
only repack packs which are cacheable
.PP
\fB--repack-small\fP[=false]
repack pack files below 80% of target pack size
.PP
\fB--repack-uncompressed\fP[=false]
repack all uncompressed data
.PP
\fB--unsafe-recover-no-free-space\fP=""
UNSAFE, READ THE DOCUMENTATION BEFORE USING! Try to recover a repository stuck with no free space. Do not use without trying out 'prune --max-repack-size 0' first.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,107 +3,115 @@
.SH NAME
.PP
restic\-rebuild\-index \- Build a new index
restic-rebuild-index - Build a new index
.SH SYNOPSIS
.PP
\fBrestic rebuild\-index [flags]\fP
\fBrestic rebuild-index [flags]\fP
.SH DESCRIPTION
.PP
The "rebuild\-index" command creates a new index based on the pack files in the
The "rebuild-index" command creates a new index based on the pack files in the
repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for rebuild\-index
\fB-h\fP, \fB--help\fP[=false]
help for rebuild-index
.PP
\fB\-\-read\-all\-packs\fP[=false]
\fB--read-all-packs\fP[=false]
read all pack files to generate new index from scratch
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-recover \- Recover data from the repository not referenced by snapshots
restic-recover - Recover data from the repository not referenced by snapshots
.SH SYNOPSIS
@ -20,87 +20,95 @@ It can be used if, for example, a snapshot has been removed by accident with "fo
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for recover
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-restore \- Extract the data from a snapshot
restic-restore - Extract the data from a snapshot
.SH SYNOPSIS
@ -23,123 +23,131 @@ repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-e\fP, \fB\-\-exclude\fP=[]
\fB-e\fP, \fB--exclude\fP=[]
exclude a \fB\fCpattern\fR (can be specified multiple times)
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for restore
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this host when the snapshot ID is "latest" (can be specified multiple times)
.PP
\fB\-\-iexclude\fP=[]
same as \fB\fC\-\-exclude\fR but ignores the casing of filenames
\fB--iexclude\fP=[]
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
\fB--iinclude\fP=[]
same as \fB\fC--include\fR but ignores the casing of filenames
.PP
\fB\-i\fP, \fB\-\-include\fP=[]
\fB-i\fP, \fB--include\fP=[]
include a \fB\fCpattern\fR, exclude everything else (can be specified multiple times)
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR for snapshot ID "latest"
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR for snapshot ID "latest"
.PP
\fB\-t\fP, \fB\-\-target\fP=""
\fB-t\fP, \fB--target\fP=""
directory to extract data to
.PP
\fB\-\-verify\fP[=false]
\fB--verify\fP[=false]
verify restored files content
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,17 +3,17 @@
.SH NAME
.PP
restic\-self\-update \- Update the restic binary
restic-self-update - Update the restic binary
.SH SYNOPSIS
.PP
\fBrestic self\-update [flags]\fP
\fBrestic self-update [flags]\fP
.SH DESCRIPTION
.PP
The command "self\-update" downloads the latest stable release of restic from
The command "self-update" downloads the latest stable release of restic from
GitHub and replaces the currently running binary. After download, the
authenticity of the binary is verified using the GPG signature on the release
files.
@ -21,91 +21,99 @@ files.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for self\-update
\fB-h\fP, \fB--help\fP[=false]
help for self-update
.PP
\fB\-\-output\fP=""
\fB--output\fP=""
Save the downloaded file as \fB\fCfilename\fR (default: running binary itself)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-snapshots \- List all snapshots
restic-snapshots - List all snapshots
.SH SYNOPSIS
@ -18,111 +18,119 @@ The "snapshots" command lists all snapshots stored in the repository.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-compact\fP[=false]
\fB-c\fP, \fB--compact\fP[=false]
use compact output format
.PP
\fB\-g\fP, \fB\-\-group\-by\fP=""
string for grouping snapshots by host,paths,tags
\fB-g\fP, \fB--group-by\fP=""
\fB\fCgroup\fR snapshots by host, paths and/or tags, separated by comma
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for snapshots
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR (can be specified multiple times)
.PP
\fB\-\-latest\fP=0
\fB--latest\fP=0
only show the last \fB\fCn\fR snapshots for each host and path
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots for this \fB\fCpath\fR (can be specified multiple times)
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-stats \- Scan the repository and show basic statistics
restic-stats - Scan the repository and show basic statistics
.SH SYNOPSIS
@ -16,7 +16,7 @@ restic\-stats \- Scan the repository and show basic statistics
The "stats" command walks one or multiple snapshots in a repository
and accumulates statistics about the data stored therein. It reports
on the number of unique files and their sizes, according to one of
the counting modes as given by the \-\-mode flag.
the counting modes as given by the --mode flag.
.PP
It operates on all snapshots matching the selection criteria or all
@ -30,15 +30,15 @@ The modes are:
.RS
.IP \(bu 2
restore\-size: (default) Counts the size of the restored files.
restore-size: (default) Counts the size of the restored files.
.IP \(bu 2
files\-by\-contents: Counts total size of files, where a file is
files-by-contents: Counts total size of files, where a file is
considered unique if it has unique contents.
.IP \(bu 2
raw\-data: Counts the size of blobs in the repository, regardless of
raw-data: Counts the size of blobs in the repository, regardless of
how many files reference them.
.IP \(bu 2
blobs\-per\-file: A combination of files\-by\-contents and raw\-data.
blobs-per-file: A combination of files-by-contents and raw-data.
.RE
@ -48,103 +48,111 @@ Refer to the online manual for more details about each mode.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for stats
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
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
\fB--mode\fP="restore-size"
counting mode: restore-size (default), files-by-contents, blobs-per-file or raw-data
.PP
\fB\-\-path\fP=[]
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times)
.PP
\fB\-\-tag\fP=[]
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,12 +3,12 @@
.SH NAME
.PP
restic\-tag \- Modify tags on snapshots
restic-tag - Modify tags on snapshots
.SH SYNOPSIS
.PP
\fBrestic tag [flags] [snapshot\-ID ...]\fP
\fBrestic tag [flags] [snapshot-ID ...]\fP
.SH DESCRIPTION
@ -20,116 +20,124 @@ You can either set/replace the entire set of tags on a snapshot, or
add tags to/remove tags from the existing set.
.PP
When no snapshot\-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
When no snapshot-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-\-add\fP=[]
\fB--add\fP=[]
\fB\fCtags\fR which will be added to the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for tag
.PP
\fB\-H\fP, \fB\-\-host\fP=[]
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (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
\fB--path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot-ID is given
.PP
\fB\-\-remove\fP=[]
\fB--remove\fP=[]
\fB\fCtags\fR which will be removed from the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
.PP
\fB\-\-set\fP=[]
\fB--set\fP=[]
\fB\fCtags\fR which will replace the existing tags in the format \fB\fCtag[,tag,...]\fR (can be given multiple times)
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot\-ID is given
\fB--tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot-ID is given
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-unlock \- Remove locks other processes created
restic-unlock - Remove locks other processes created
.SH SYNOPSIS
@ -18,91 +18,99 @@ The "unlock" command removes stale locks that have been created by other restic
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for unlock
.PP
\fB\-\-remove\-all\fP[=false]
remove all locks, even non\-stale ones
\fB--remove-all\fP[=false]
remove all locks, even non-stale ones
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

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

@ -3,7 +3,7 @@
.SH NAME
.PP
restic\-version \- Print version information
restic-version - Print version information
.SH SYNOPSIS
@ -19,87 +19,95 @@ and the version of this software.
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
Exit status is 0 if the command was successful, and non-zero if there was any error.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB-h\fP, \fB--help\fP[=false]
help for version
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB\-\-json\fP[=false]
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO

66
doc/man/restic.1
View file

@ -3,7 +3,7 @@
.SH NAME
.PP
restic \- Backup and restore files
restic - Backup and restore files
.SH SYNOPSIS
@ -19,82 +19,90 @@ directories in an encrypted repository stored on different backends.
.SH OPTIONS
.PP
\fB\-\-cacert\fP=[]
\fB--cacert\fP=[]
\fB\fCfile\fR to load root certificates from (default: use system certificates)
.PP
\fB\-\-cache\-dir\fP=""
\fB--cache-dir\fP=""
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
.PP
\fB\-\-cleanup\-cache\fP[=false]
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max)
.PP
\fB-h\fP, \fB--help\fP[=false]
help for restic
.PP
\fB\-\-insecure\-tls\fP[=false]
skip TLS certificate verification when connecting to the repo (insecure)
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB\-\-json\fP[=false]
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB\-\-key\-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
\fB--key-hint\fP=""
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB\-\-limit\-download\fP=0
\fB--limit-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
\fB--limit-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-no\-cache\fP[=false]
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repository, this allows some operations on read\-only repositories
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
\fB-o\fP, \fB--option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
.PP
\fB\-\-password\-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
\fB--pack-size\fP=0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
\fB--password-command\fP=""
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
\fB-p\fP, \fB--password-file\fP=""
\fB\fCfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
.PP
\fB-q\fP, \fB--quiet\fP[=false]
do not output comprehensive progress report
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
\fB-r\fP, \fB--repo\fP=""
\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)
\fB--repository-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.PP
\fB\-\-tls\-client\-cert\fP=""
\fB--tls-client-cert\fP=""
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=\fB\fCn\fR, max level/times is 3)
.SH SEE ALSO
.PP
\fBrestic\-backup(1)\fP, \fBrestic\-cache(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-copy(1)\fP, \fBrestic\-diff(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-recover(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-self\-update(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-stats(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP
\fBrestic-backup(1)\fP, \fBrestic-cache(1)\fP, \fBrestic-cat(1)\fP, \fBrestic-check(1)\fP, \fBrestic-copy(1)\fP, \fBrestic-diff(1)\fP, \fBrestic-dump(1)\fP, \fBrestic-find(1)\fP, \fBrestic-forget(1)\fP, \fBrestic-generate(1)\fP, \fBrestic-init(1)\fP, \fBrestic-key(1)\fP, \fBrestic-list(1)\fP, \fBrestic-ls(1)\fP, \fBrestic-migrate(1)\fP, \fBrestic-mount(1)\fP, \fBrestic-prune(1)\fP, \fBrestic-rebuild-index(1)\fP, \fBrestic-recover(1)\fP, \fBrestic-restore(1)\fP, \fBrestic-self-update(1)\fP, \fBrestic-snapshots(1)\fP, \fBrestic-stats(1)\fP, \fBrestic-tag(1)\fP, \fBrestic-unlock(1)\fP, \fBrestic-version(1)\fP

36
doc/zsh-completion.zsh
View file

@ -1,4 +1,4 @@
#compdef _restic restic
#compdef restic
# zsh completion for restic -*- shell-script -*-
@ -86,7 +86,24 @@ _restic()
return
fi
local activeHelpMarker="_activeHelp_ "
local endIndex=${#activeHelpMarker}
local startIndex=$((${#activeHelpMarker}+1))
local hasActiveHelp=0
while IFS='\n' read -r comp; do
# Check if this is an activeHelp statement (i.e., prefixed with $activeHelpMarker)
if [ "${comp[1,$endIndex]}" = "$activeHelpMarker" ];then
__restic_debug "ActiveHelp found: $comp"
comp="${comp[$startIndex,-1]}"
if [ -n "$comp" ]; then
compadd -x "${comp}"
__restic_debug "ActiveHelp will need delimiter"
hasActiveHelp=1
fi
continue
fi
if [ -n "$comp" ]; then
# If requested, completions are returned with a description.
# The description is preceded by a TAB character.
@ -94,7 +111,7 @@ _restic()
# We first need to escape any : as part of the completion itself.
comp=${comp//:/\\:}
local tab=$(printf '\t')
local tab="$(printf '\t')"
comp=${comp//$tab/:}
__restic_debug "Adding completion: ${comp}"
@ -103,6 +120,17 @@ _restic()
fi
done < <(printf "%s\n" "${out[@]}")
# Add a delimiter after the activeHelp statements, but only if:
# - there are completions following the activeHelp statements, or
# - file completion will be performed (so there will be choices after the activeHelp)
if [ $hasActiveHelp -eq 1 ]; then
if [ ${#completions} -ne 0 ] || [ $((directive & shellCompDirectiveNoFileComp)) -eq 0 ]; then
__restic_debug "Adding activeHelp delimiter"
compadd -x "--"
hasActiveHelp=0
fi
fi
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
__restic_debug "Activating nospace."
noSpace="-S ''"
@ -125,7 +153,7 @@ _restic()
_arguments '*:filename:'"$filteringCmd"
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
# File completion for directories only
local subDir
local subdir
subdir="${completions[1]}"
if [ -n "$subdir" ]; then
__restic_debug "Listing directories in $subdir"
@ -173,5 +201,5 @@ _restic()
# don't run the completion function when being source-ed or eval-ed
if [ "$funcstack[1]" = "_restic" ]; then
_restic
_restic
fi