diff --git a/doc/bash-completion.sh b/doc/bash-completion.sh index cae37a6ca..9d64871ca 100644 --- a/doc/bash-completion.sh +++ b/doc/bash-completion.sh @@ -49,7 +49,7 @@ __restic_handle_go_custom_completion() local out requestComp lastParam lastChar comp directive args # Prepare the command to request completions for the program. - # Calling ${words[0]} instead of directly restic allows to handle aliases + # Calling ${words[0]} instead of directly restic allows handling aliases args=("${words[@]:1}") # Disable ActiveHelp which is not supported for bash completion v1 requestComp="RESTIC_ACTIVE_HELP=0 ${words[0]} __completeNoDesc ${args[*]}" @@ -456,12 +456,16 @@ _restic_backup() two_word_flags+=("--read-concurrency") local_nonpersistent_flags+=("--read-concurrency") local_nonpersistent_flags+=("--read-concurrency=") + flags+=("--skip-if-unchanged") + local_nonpersistent_flags+=("--skip-if-unchanged") flags+=("--stdin") local_nonpersistent_flags+=("--stdin") flags+=("--stdin-filename=") two_word_flags+=("--stdin-filename") local_nonpersistent_flags+=("--stdin-filename") local_nonpersistent_flags+=("--stdin-filename=") + flags+=("--stdin-from-command") + local_nonpersistent_flags+=("--stdin-from-command") flags+=("--tag=") two_word_flags+=("--tag") local_nonpersistent_flags+=("--tag") @@ -479,6 +483,9 @@ _restic_backup() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -552,6 +559,9 @@ _restic_cache() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -617,6 +627,9 @@ _restic_cat() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -690,6 +703,9 @@ _restic_check() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -744,6 +760,8 @@ _restic_copy() flags_with_completion=() flags_completion=() + flags+=("--from-insecure-no-password") + local_nonpersistent_flags+=("--from-insecure-no-password") flags+=("--from-key-hint=") two_word_flags+=("--from-key-hint") local_nonpersistent_flags+=("--from-key-hint") @@ -789,6 +807,9 @@ _restic_copy() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -856,6 +877,9 @@ _restic_diff() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -934,6 +958,12 @@ _restic_dump() two_word_flags+=("--tag") local_nonpersistent_flags+=("--tag") local_nonpersistent_flags+=("--tag=") + flags+=("--target=") + two_word_flags+=("--target") + two_word_flags+=("-t") + local_nonpersistent_flags+=("--target") + local_nonpersistent_flags+=("--target=") + local_nonpersistent_flags+=("-t") flags+=("--cacert=") two_word_flags+=("--cacert") flags+=("--cache-dir=") @@ -941,6 +971,9 @@ _restic_dump() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1056,6 +1089,9 @@ _restic_find() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1174,6 +1210,8 @@ _restic_forget() two_word_flags+=("--keep-tag") local_nonpersistent_flags+=("--keep-tag") local_nonpersistent_flags+=("--keep-tag=") + flags+=("--unsafe-allow-remove-all") + local_nonpersistent_flags+=("--unsafe-allow-remove-all") flags+=("--host=") two_word_flags+=("--host") local_nonpersistent_flags+=("--host") @@ -1227,6 +1265,9 @@ _restic_forget() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1312,6 +1353,9 @@ _restic_generate() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1373,6 +1417,9 @@ _restic_help() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1430,6 +1477,8 @@ _restic_init() flags+=("--copy-chunker-params") local_nonpersistent_flags+=("--copy-chunker-params") + flags+=("--from-insecure-no-password") + local_nonpersistent_flags+=("--from-insecure-no-password") flags+=("--from-key-hint=") two_word_flags+=("--from-key-hint") local_nonpersistent_flags+=("--from-key-hint") @@ -1465,6 +1514,374 @@ _restic_init() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") + flags+=("--insecure-tls") + flags+=("--json") + flags+=("--key-hint=") + two_word_flags+=("--key-hint") + flags+=("--limit-download=") + two_word_flags+=("--limit-download") + flags+=("--limit-upload=") + two_word_flags+=("--limit-upload") + flags+=("--no-cache") + flags+=("--no-extra-verify") + flags+=("--no-lock") + 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=") + two_word_flags+=("--password-file") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("--repo") + two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") + flags+=("--retry-lock=") + two_word_flags+=("--retry-lock") + flags+=("--tls-client-cert=") + two_word_flags+=("--tls-client-cert") + flags+=("--verbose") + flags+=("-v") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_key_add() +{ + last_command="restic_key_add" + + command_aliases=() + + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + local_nonpersistent_flags+=("-h") + flags+=("--host=") + two_word_flags+=("--host") + local_nonpersistent_flags+=("--host") + local_nonpersistent_flags+=("--host=") + flags+=("--new-insecure-no-password") + local_nonpersistent_flags+=("--new-insecure-no-password") + flags+=("--new-password-file=") + two_word_flags+=("--new-password-file") + local_nonpersistent_flags+=("--new-password-file") + local_nonpersistent_flags+=("--new-password-file=") + flags+=("--user=") + two_word_flags+=("--user") + local_nonpersistent_flags+=("--user") + local_nonpersistent_flags+=("--user=") + flags+=("--cacert=") + two_word_flags+=("--cacert") + flags+=("--cache-dir=") + two_word_flags+=("--cache-dir") + flags+=("--cleanup-cache") + flags+=("--compression=") + two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") + flags+=("--insecure-tls") + flags+=("--json") + flags+=("--key-hint=") + two_word_flags+=("--key-hint") + flags+=("--limit-download=") + two_word_flags+=("--limit-download") + flags+=("--limit-upload=") + two_word_flags+=("--limit-upload") + flags+=("--no-cache") + flags+=("--no-extra-verify") + flags+=("--no-lock") + 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=") + two_word_flags+=("--password-file") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("--repo") + two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") + flags+=("--retry-lock=") + two_word_flags+=("--retry-lock") + flags+=("--tls-client-cert=") + two_word_flags+=("--tls-client-cert") + flags+=("--verbose") + flags+=("-v") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_key_help() +{ + last_command="restic_key_help" + + command_aliases=() + + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--cacert=") + two_word_flags+=("--cacert") + flags+=("--cache-dir=") + two_word_flags+=("--cache-dir") + flags+=("--cleanup-cache") + flags+=("--compression=") + two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") + flags+=("--insecure-tls") + flags+=("--json") + flags+=("--key-hint=") + two_word_flags+=("--key-hint") + flags+=("--limit-download=") + two_word_flags+=("--limit-download") + flags+=("--limit-upload=") + two_word_flags+=("--limit-upload") + flags+=("--no-cache") + flags+=("--no-extra-verify") + flags+=("--no-lock") + 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=") + two_word_flags+=("--password-file") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("--repo") + two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") + flags+=("--retry-lock=") + two_word_flags+=("--retry-lock") + flags+=("--tls-client-cert=") + two_word_flags+=("--tls-client-cert") + flags+=("--verbose") + flags+=("-v") + + must_have_one_flag=() + must_have_one_noun=() + has_completion_function=1 + noun_aliases=() +} + +_restic_key_list() +{ + last_command="restic_key_list" + + command_aliases=() + + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + local_nonpersistent_flags+=("-h") + flags+=("--cacert=") + two_word_flags+=("--cacert") + flags+=("--cache-dir=") + two_word_flags+=("--cache-dir") + flags+=("--cleanup-cache") + flags+=("--compression=") + two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") + flags+=("--insecure-tls") + flags+=("--json") + flags+=("--key-hint=") + two_word_flags+=("--key-hint") + flags+=("--limit-download=") + two_word_flags+=("--limit-download") + flags+=("--limit-upload=") + two_word_flags+=("--limit-upload") + flags+=("--no-cache") + flags+=("--no-extra-verify") + flags+=("--no-lock") + 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=") + two_word_flags+=("--password-file") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("--repo") + two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") + flags+=("--retry-lock=") + two_word_flags+=("--retry-lock") + flags+=("--tls-client-cert=") + two_word_flags+=("--tls-client-cert") + flags+=("--verbose") + flags+=("-v") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_key_passwd() +{ + last_command="restic_key_passwd" + + command_aliases=() + + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + local_nonpersistent_flags+=("-h") + flags+=("--host=") + two_word_flags+=("--host") + local_nonpersistent_flags+=("--host") + local_nonpersistent_flags+=("--host=") + flags+=("--new-insecure-no-password") + local_nonpersistent_flags+=("--new-insecure-no-password") + flags+=("--new-password-file=") + two_word_flags+=("--new-password-file") + local_nonpersistent_flags+=("--new-password-file") + local_nonpersistent_flags+=("--new-password-file=") + flags+=("--user=") + two_word_flags+=("--user") + local_nonpersistent_flags+=("--user") + local_nonpersistent_flags+=("--user=") + flags+=("--cacert=") + two_word_flags+=("--cacert") + flags+=("--cache-dir=") + two_word_flags+=("--cache-dir") + flags+=("--cleanup-cache") + flags+=("--compression=") + two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") + flags+=("--insecure-tls") + flags+=("--json") + flags+=("--key-hint=") + two_word_flags+=("--key-hint") + flags+=("--limit-download=") + two_word_flags+=("--limit-download") + flags+=("--limit-upload=") + two_word_flags+=("--limit-upload") + flags+=("--no-cache") + flags+=("--no-extra-verify") + flags+=("--no-lock") + 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=") + two_word_flags+=("--password-file") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("--repo") + two_word_flags+=("-r") + flags+=("--repository-file=") + two_word_flags+=("--repository-file") + flags+=("--retry-lock=") + two_word_flags+=("--retry-lock") + flags+=("--tls-client-cert=") + two_word_flags+=("--tls-client-cert") + flags+=("--verbose") + flags+=("-v") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_key_remove() +{ + last_command="restic_key_remove" + + command_aliases=() + + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + local_nonpersistent_flags+=("-h") + flags+=("--cacert=") + two_word_flags+=("--cacert") + flags+=("--cache-dir=") + two_word_flags+=("--cache-dir") + flags+=("--cleanup-cache") + flags+=("--compression=") + two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1512,6 +1929,11 @@ _restic_key() command_aliases=() commands=() + commands+=("add") + commands+=("help") + commands+=("list") + commands+=("passwd") + commands+=("remove") flags=() two_word_flags=() @@ -1523,18 +1945,6 @@ _restic_key() flags+=("-h") local_nonpersistent_flags+=("--help") local_nonpersistent_flags+=("-h") - flags+=("--host=") - two_word_flags+=("--host") - local_nonpersistent_flags+=("--host") - local_nonpersistent_flags+=("--host=") - flags+=("--new-password-file=") - two_word_flags+=("--new-password-file") - local_nonpersistent_flags+=("--new-password-file") - local_nonpersistent_flags+=("--new-password-file=") - flags+=("--user=") - two_word_flags+=("--user") - local_nonpersistent_flags+=("--user") - local_nonpersistent_flags+=("--user=") flags+=("--cacert=") two_word_flags+=("--cacert") flags+=("--cache-dir=") @@ -1542,6 +1952,9 @@ _restic_key() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1607,6 +2020,9 @@ _restic_list() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1677,6 +2093,8 @@ _restic_ls() flags+=("-l") local_nonpersistent_flags+=("--long") local_nonpersistent_flags+=("-l") + flags+=("--ncdu") + local_nonpersistent_flags+=("--ncdu") flags+=("--path=") two_word_flags+=("--path") local_nonpersistent_flags+=("--path") @@ -1694,6 +2112,9 @@ _restic_ls() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1763,6 +2184,9 @@ _restic_migrate() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1856,6 +2280,9 @@ _restic_mount() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -1943,6 +2370,9 @@ _restic_prune() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2008,6 +2438,9 @@ _restic_recover() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2069,6 +2502,9 @@ _restic_repair_help() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2137,6 +2573,9 @@ _restic_repair_index() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2202,6 +2641,9 @@ _restic_repair_packs() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2287,6 +2729,9 @@ _restic_repair_snapshots() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2356,6 +2801,9 @@ _restic_repair() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2410,12 +2858,20 @@ _restic_restore() flags_with_completion=() flags_completion=() + flags+=("--delete") + local_nonpersistent_flags+=("--delete") + flags+=("--dry-run") + local_nonpersistent_flags+=("--dry-run") flags+=("--exclude=") two_word_flags+=("--exclude") two_word_flags+=("-e") local_nonpersistent_flags+=("--exclude") local_nonpersistent_flags+=("--exclude=") local_nonpersistent_flags+=("-e") + flags+=("--exclude-file=") + two_word_flags+=("--exclude-file") + local_nonpersistent_flags+=("--exclude-file") + local_nonpersistent_flags+=("--exclude-file=") flags+=("--help") flags+=("-h") local_nonpersistent_flags+=("--help") @@ -2430,16 +2886,32 @@ _restic_restore() two_word_flags+=("--iexclude") local_nonpersistent_flags+=("--iexclude") local_nonpersistent_flags+=("--iexclude=") + flags+=("--iexclude-file=") + two_word_flags+=("--iexclude-file") + local_nonpersistent_flags+=("--iexclude-file") + local_nonpersistent_flags+=("--iexclude-file=") flags+=("--iinclude=") two_word_flags+=("--iinclude") local_nonpersistent_flags+=("--iinclude") local_nonpersistent_flags+=("--iinclude=") + flags+=("--iinclude-file=") + two_word_flags+=("--iinclude-file") + local_nonpersistent_flags+=("--iinclude-file") + local_nonpersistent_flags+=("--iinclude-file=") flags+=("--include=") two_word_flags+=("--include") two_word_flags+=("-i") local_nonpersistent_flags+=("--include") local_nonpersistent_flags+=("--include=") local_nonpersistent_flags+=("-i") + flags+=("--include-file=") + two_word_flags+=("--include-file") + local_nonpersistent_flags+=("--include-file") + local_nonpersistent_flags+=("--include-file=") + flags+=("--overwrite=") + two_word_flags+=("--overwrite") + local_nonpersistent_flags+=("--overwrite") + local_nonpersistent_flags+=("--overwrite=") flags+=("--path=") two_word_flags+=("--path") local_nonpersistent_flags+=("--path") @@ -2465,6 +2937,9 @@ _restic_restore() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2553,6 +3028,14 @@ _restic_rewrite() two_word_flags+=("--iexclude-file") local_nonpersistent_flags+=("--iexclude-file") local_nonpersistent_flags+=("--iexclude-file=") + flags+=("--new-host=") + two_word_flags+=("--new-host") + local_nonpersistent_flags+=("--new-host") + local_nonpersistent_flags+=("--new-host=") + flags+=("--new-time=") + two_word_flags+=("--new-time") + local_nonpersistent_flags+=("--new-time") + local_nonpersistent_flags+=("--new-time=") flags+=("--path=") two_word_flags+=("--path") local_nonpersistent_flags+=("--path") @@ -2568,6 +3051,9 @@ _restic_rewrite() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2637,6 +3123,9 @@ _restic_self-update() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2730,6 +3219,9 @@ _restic_snapshots() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2813,6 +3305,9 @@ _restic_stats() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2904,6 +3399,9 @@ _restic_tag() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -2971,6 +3469,9 @@ _restic_unlock() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -3036,6 +3537,9 @@ _restic_version() flags+=("--cleanup-cache") flags+=("--compression=") two_word_flags+=("--compression") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") @@ -3129,6 +3633,9 @@ _restic_root_command() flags+=("-h") local_nonpersistent_flags+=("--help") local_nonpersistent_flags+=("-h") + flags+=("--http-user-agent=") + two_word_flags+=("--http-user-agent") + flags+=("--insecure-no-password") flags+=("--insecure-tls") flags+=("--json") flags+=("--key-hint=") diff --git a/doc/man/restic-backup.1 b/doc/man/restic-backup.1 index 730685271..cda4aadff 100644 --- a/doc/man/restic-backup.1 +++ b/doc/man/restic-backup.1 @@ -22,6 +22,8 @@ given as the arguments. Exit status is 0 if the command was successful. Exit status is 1 if there was a fatal error (no snapshot created). Exit status is 3 if some source data could not be read (incomplete snapshot created). +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -63,7 +65,7 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea .PP \fB-f\fP, \fB--force\fP[=false] - force re-reading the target files/directories (overrides the "parent" flag) + force re-reading the source files/directories (overrides the "parent" flag) .PP \fB-g\fP, \fB--group-by\fP=host,paths @@ -75,7 +77,7 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea .PP \fB-H\fP, \fB--host\fP="" - set the \fBhostname\fR for the snapshot manually. To prevent an expensive rescan use the "parent" flag + set the \fBhostname\fR for the snapshot manually (default: $RESTIC_HOST). To prevent an expensive rescan use the "parent" flag .PP \fB--iexclude\fP=[] @@ -91,7 +93,7 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea .PP \fB--ignore-inode\fP[=false] - ignore inode number changes when checking for modified files + ignore inode number and ctime changes when checking for modified files .PP \fB--no-scan\fP[=false] @@ -109,6 +111,10 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea \fB--read-concurrency\fP=0 read \fBn\fR files concurrently (default: $RESTIC_READ_CONCURRENCY or 2) +.PP +\fB--skip-if-unchanged\fP[=false] + skip snapshot creation if identical to parent snapshot + .PP \fB--stdin\fP[=false] read backup from stdin @@ -117,6 +123,10 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea \fB--stdin-filename\fP="stdin" \fBfilename\fR to use when reading from stdin +.PP +\fB--stdin-from-command\fP[=false] + interpret arguments as command to execute and store its stdout + .PP \fB--tag\fP=[] add \fBtags\fR for the new snapshot in the format \fBtag[,tag,...]\fR (can be specified multiple times) @@ -147,6 +157,14 @@ Exit status is 3 if some source data could not be read (incomplete snapshot crea \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-cache.1 b/doc/man/restic-cache.1 index c170c1624..f868b8a6b 100644 --- a/doc/man/restic-cache.1 +++ b/doc/man/restic-cache.1 @@ -18,7 +18,8 @@ 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. +Exit status is 1 if there was any error. .SH OPTIONS @@ -56,6 +57,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-cat.1 b/doc/man/restic-cat.1 index b42a58e14..2298c58cf 100644 --- a/doc/man/restic-cat.1 +++ b/doc/man/restic-cat.1 @@ -18,7 +18,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -44,6 +47,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-check.1 b/doc/man/restic-check.1 index 9c1dc77e5..c0d1b07a8 100644 --- a/doc/man/restic-check.1 +++ b/doc/man/restic-check.1 @@ -23,7 +23,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -61,6 +64,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-copy.1 b/doc/man/restic-copy.1 index bd9795f44..63b67e5e7 100644 --- a/doc/man/restic-copy.1 +++ b/doc/man/restic-copy.1 @@ -30,7 +30,19 @@ This can be mitigated by the "--copy-chunker-params" option when initializing a new destination repository using the "init" command. +.SH EXIT STATUS +.PP +Exit status is 0 if the command was successful. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. + + .SH OPTIONS +.PP +\fB--from-insecure-no-password\fP[=false] + use an empty password for the source repository, must be passed to every restic command (insecure) + .PP \fB--from-key-hint\fP="" key ID of key to try decrypting the source repository first (default: $RESTIC_FROM_KEY_HINT) @@ -57,11 +69,11 @@ new destination repository using the "init" command. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] @@ -85,6 +97,14 @@ new destination repository using the "init" command. \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-diff.1 b/doc/man/restic-diff.1 index 28f3a4838..f4ffa2737 100644 --- a/doc/man/restic-diff.1 +++ b/doc/man/restic-diff.1 @@ -28,18 +28,27 @@ U The metadata (access mode, timestamps, ...) for the item was updated M The file's content was modified .IP \(bu 2 T The type was changed, e.g. a file was made a symlink +.IP \(bu 2 +? Bitrot detected: The file's content has changed but all metadata is the same .RE +.PP +Metadata comparison will likely not work if a backup was created using the +\&'--ignore-inode' or '--ignore-ctime' option. + .PP To only compare files in specific subfolders, you can use the -":" syntax, where "subfolder" is a path within the +"snapshotID:subfolder" syntax, where "subfolder" is a path within the snapshot. .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -69,6 +78,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-dump.1 b/doc/man/restic-dump.1 index 7fa3f777d..00cb3c8b6 100644 --- a/doc/man/restic-dump.1 +++ b/doc/man/restic-dump.1 @@ -24,13 +24,16 @@ repository. .PP To include the folder content at the root of the archive, you can use the -":" syntax, where "subfolder" is a path within the +"snapshotID:subfolder" syntax, where "subfolder" is a path within the snapshot. .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -44,16 +47,20 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] only consider snapshots including \fBtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times) +.PP +\fB-t\fP, \fB--target\fP="" + write the output to target \fBpath\fR + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP @@ -72,6 +79,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-find.1 b/doc/man/restic-find.1 index c3297c43f..2d81decd3 100644 --- a/doc/man/restic-find.1 +++ b/doc/man/restic-find.1 @@ -29,7 +29,7 @@ It can also be used to search for restic blobs or trees for troubleshooting. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--human-readable\fP[=false] @@ -57,7 +57,7 @@ It can also be used to search for restic blobs or trees for troubleshooting. .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--show-pack-id\fP[=false] @@ -93,6 +93,14 @@ It can also be used to search for restic blobs or trees for troubleshooting. \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) @@ -178,8 +186,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .EE diff --git a/doc/man/restic-forget.1 b/doc/man/restic-forget.1 index d0c4cfc74..55705288f 100644 --- a/doc/man/restic-forget.1 +++ b/doc/man/restic-forget.1 @@ -15,7 +15,10 @@ restic-forget - Remove snapshots from the repository .PP 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. +specified by the "--keep-\fI" options is applied to each group individually. +If there are not enough snapshots to keep one for each duration related +"--keep-{within-,}\fP" option, the oldest snapshot in the group is kept +additionally. .PP Please note that this command really only deletes the snapshot object in the @@ -29,7 +32,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -85,9 +91,13 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--keep-tag\fP=[] keep snapshots with this \fBtaglist\fR (can be specified multiple times) +.PP +\fB--unsafe-allow-remove-all\fP[=false] + allow deleting all snapshots of a snapshot group + .PP \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--tag\fP=[] @@ -95,7 +105,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB-c\fP, \fB--compact\fP[=false] @@ -155,6 +165,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-generate.1 b/doc/man/restic-generate.1 index 84f659ef2..f2db39bac 100644 --- a/doc/man/restic-generate.1 +++ b/doc/man/restic-generate.1 @@ -19,7 +19,8 @@ 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. +Exit status is 1 if there was any error. .SH OPTIONS @@ -65,6 +66,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-init.1 b/doc/man/restic-init.1 index 5f19c8f8c..de439add5 100644 --- a/doc/man/restic-init.1 +++ b/doc/man/restic-init.1 @@ -18,7 +18,8 @@ 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. +Exit status is 1 if there was any error. .SH OPTIONS @@ -26,6 +27,10 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--copy-chunker-params\fP[=false] copy chunker parameters from the secondary repository (useful with the copy command) +.PP +\fB--from-insecure-no-password\fP[=false] + use an empty password for the source repository, must be passed to every restic command (insecure) + .PP \fB--from-key-hint\fP="" key ID of key to try decrypting the source repository first (default: $RESTIC_FROM_KEY_HINT) @@ -72,6 +77,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-key-add.1 b/doc/man/restic-key-add.1 new file mode 100644 index 000000000..6a24e1e67 --- /dev/null +++ b/doc/man/restic-key-add.1 @@ -0,0 +1,149 @@ +.nh +.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" + +.SH NAME +.PP +restic-key-add - Add a new key (password) to the repository; returns the new key ID + + +.SH SYNOPSIS +.PP +\fBrestic key add [flags]\fP + + +.SH DESCRIPTION +.PP +The "add" sub-command creates a new key and validates the key. Returns the new key ID. + + +.SH EXIT STATUS +.PP +Exit status is 0 if the command was successful. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for add + +.PP +\fB--host\fP="" + the hostname for new key + +.PP +\fB--new-insecure-no-password\fP[=false] + add an empty password for the repository (insecure) + +.PP +\fB--new-password-file\fP="" + \fBfile\fR from which to read the new password + +.PP +\fB--user\fP="" + the username for new key + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--cacert\fP=[] + \fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT) + +.PP +\fB--cache-dir\fP="" + set the cache \fBdirectory\fR\&. (default: use system default cache directory) + +.PP +\fB--cleanup-cache\fP[=false] + auto remove old cache directories + +.PP +\fB--compression\fP=auto + compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + +.PP +\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="" + \fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT) + +.PP +\fB--limit-download\fP=0 + limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--limit-upload\fP=0 + limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--no-cache\fP[=false] + do not use a local cache + +.PP +\fB--no-extra-verify\fP[=false] + skip additional verification of data before upload (see documentation) + +.PP +\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=[] + set extended option (\fBkey=value\fR, can be specified multiple times) + +.PP +\fB--pack-size\fP=0 + set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE) + +.PP +\fB--password-command\fP="" + shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) + +.PP +\fB-p\fP, \fB--password-file\fP="" + \fBfile\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="" + \fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY) + +.PP +\fB--repository-file\fP="" + \fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE) + +.PP +\fB--retry-lock\fP=0s + retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries) + +.PP +\fB--tls-client-cert\fP="" + path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT) + +.PP +\fB-v\fP, \fB--verbose\fP[=0] + be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2) + + +.SH SEE ALSO +.PP +\fBrestic-key(1)\fP diff --git a/doc/man/restic-key-list.1 b/doc/man/restic-key-list.1 new file mode 100644 index 000000000..a00b116b9 --- /dev/null +++ b/doc/man/restic-key-list.1 @@ -0,0 +1,135 @@ +.nh +.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" + +.SH NAME +.PP +restic-key-list - List keys (passwords) + + +.SH SYNOPSIS +.PP +\fBrestic key list [flags]\fP + + +.SH DESCRIPTION +.PP +The "list" sub-command lists all the keys (passwords) associated with the repository. +Returns the key ID, username, hostname, created time and if it's the current key being +used to access the repository. + + +.SH EXIT STATUS +.PP +Exit status is 0 if the command was successful. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for list + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--cacert\fP=[] + \fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT) + +.PP +\fB--cache-dir\fP="" + set the cache \fBdirectory\fR\&. (default: use system default cache directory) + +.PP +\fB--cleanup-cache\fP[=false] + auto remove old cache directories + +.PP +\fB--compression\fP=auto + compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + +.PP +\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="" + \fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT) + +.PP +\fB--limit-download\fP=0 + limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--limit-upload\fP=0 + limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--no-cache\fP[=false] + do not use a local cache + +.PP +\fB--no-extra-verify\fP[=false] + skip additional verification of data before upload (see documentation) + +.PP +\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=[] + set extended option (\fBkey=value\fR, can be specified multiple times) + +.PP +\fB--pack-size\fP=0 + set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE) + +.PP +\fB--password-command\fP="" + shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) + +.PP +\fB-p\fP, \fB--password-file\fP="" + \fBfile\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="" + \fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY) + +.PP +\fB--repository-file\fP="" + \fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE) + +.PP +\fB--retry-lock\fP=0s + retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries) + +.PP +\fB--tls-client-cert\fP="" + path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT) + +.PP +\fB-v\fP, \fB--verbose\fP[=0] + be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2) + + +.SH SEE ALSO +.PP +\fBrestic-key(1)\fP diff --git a/doc/man/restic-key-passwd.1 b/doc/man/restic-key-passwd.1 new file mode 100644 index 000000000..42315d72a --- /dev/null +++ b/doc/man/restic-key-passwd.1 @@ -0,0 +1,150 @@ +.nh +.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" + +.SH NAME +.PP +restic-key-passwd - Change key (password); creates a new key ID and removes the old key ID, returns new key ID + + +.SH SYNOPSIS +.PP +\fBrestic key passwd [flags]\fP + + +.SH DESCRIPTION +.PP +The "passwd" sub-command creates a new key, validates the key and remove the old key ID. +Returns the new key ID. + + +.SH EXIT STATUS +.PP +Exit status is 0 if the command was successful. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for passwd + +.PP +\fB--host\fP="" + the hostname for new key + +.PP +\fB--new-insecure-no-password\fP[=false] + add an empty password for the repository (insecure) + +.PP +\fB--new-password-file\fP="" + \fBfile\fR from which to read the new password + +.PP +\fB--user\fP="" + the username for new key + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--cacert\fP=[] + \fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT) + +.PP +\fB--cache-dir\fP="" + set the cache \fBdirectory\fR\&. (default: use system default cache directory) + +.PP +\fB--cleanup-cache\fP[=false] + auto remove old cache directories + +.PP +\fB--compression\fP=auto + compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + +.PP +\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="" + \fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT) + +.PP +\fB--limit-download\fP=0 + limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--limit-upload\fP=0 + limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--no-cache\fP[=false] + do not use a local cache + +.PP +\fB--no-extra-verify\fP[=false] + skip additional verification of data before upload (see documentation) + +.PP +\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=[] + set extended option (\fBkey=value\fR, can be specified multiple times) + +.PP +\fB--pack-size\fP=0 + set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE) + +.PP +\fB--password-command\fP="" + shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) + +.PP +\fB-p\fP, \fB--password-file\fP="" + \fBfile\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="" + \fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY) + +.PP +\fB--repository-file\fP="" + \fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE) + +.PP +\fB--retry-lock\fP=0s + retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries) + +.PP +\fB--tls-client-cert\fP="" + path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT) + +.PP +\fB-v\fP, \fB--verbose\fP[=0] + be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2) + + +.SH SEE ALSO +.PP +\fBrestic-key(1)\fP diff --git a/doc/man/restic-key-remove.1 b/doc/man/restic-key-remove.1 new file mode 100644 index 000000000..6ee826059 --- /dev/null +++ b/doc/man/restic-key-remove.1 @@ -0,0 +1,134 @@ +.nh +.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" + +.SH NAME +.PP +restic-key-remove - Remove key ID (password) from the repository. + + +.SH SYNOPSIS +.PP +\fBrestic key remove [ID] [flags]\fP + + +.SH DESCRIPTION +.PP +The "remove" sub-command removes the selected key ID. The "remove" command does not allow +removing the current key being used to access the repository. + + +.SH EXIT STATUS +.PP +Exit status is 0 if the command was successful. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for remove + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB--cacert\fP=[] + \fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT) + +.PP +\fB--cache-dir\fP="" + set the cache \fBdirectory\fR\&. (default: use system default cache directory) + +.PP +\fB--cleanup-cache\fP[=false] + auto remove old cache directories + +.PP +\fB--compression\fP=auto + compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + +.PP +\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="" + \fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT) + +.PP +\fB--limit-download\fP=0 + limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--limit-upload\fP=0 + limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited) + +.PP +\fB--no-cache\fP[=false] + do not use a local cache + +.PP +\fB--no-extra-verify\fP[=false] + skip additional verification of data before upload (see documentation) + +.PP +\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=[] + set extended option (\fBkey=value\fR, can be specified multiple times) + +.PP +\fB--pack-size\fP=0 + set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE) + +.PP +\fB--password-command\fP="" + shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) + +.PP +\fB-p\fP, \fB--password-file\fP="" + \fBfile\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="" + \fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY) + +.PP +\fB--repository-file\fP="" + \fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE) + +.PP +\fB--retry-lock\fP=0s + retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries) + +.PP +\fB--tls-client-cert\fP="" + path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT) + +.PP +\fB-v\fP, \fB--verbose\fP[=0] + be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2) + + +.SH SEE ALSO +.PP +\fBrestic-key(1)\fP diff --git a/doc/man/restic-key.1 b/doc/man/restic-key.1 index 8d1813188..43da808cc 100644 --- a/doc/man/restic-key.1 +++ b/doc/man/restic-key.1 @@ -8,17 +8,13 @@ restic-key - Manage keys (passwords) .SH SYNOPSIS .PP -\fBrestic key [flags] [list|add|remove|passwd] [ID]\fP +\fBrestic key [flags]\fP .SH DESCRIPTION .PP -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. +The "key" command allows you to set multiple access keys or passwords +per repository. .SH OPTIONS @@ -26,18 +22,6 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB-h\fP, \fB--help\fP[=false] help for key -.PP -\fB--host\fP="" - the hostname for new keys - -.PP -\fB--new-password-file\fP="" - \fBfile\fR from which to read the new password - -.PP -\fB--user\fP="" - the username for new keys - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP @@ -56,6 +40,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) @@ -131,4 +123,4 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .SH SEE ALSO .PP -\fBrestic(1)\fP +\fBrestic(1)\fP, \fBrestic-key-add(1)\fP, \fBrestic-key-list(1)\fP, \fBrestic-key-passwd(1)\fP, \fBrestic-key-remove(1)\fP diff --git a/doc/man/restic-list.1 b/doc/man/restic-list.1 index e399038a2..f8a1db005 100644 --- a/doc/man/restic-list.1 +++ b/doc/man/restic-list.1 @@ -18,7 +18,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -44,6 +47,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-ls.1 b/doc/man/restic-ls.1 index 10b0657a3..6cc662583 100644 --- a/doc/man/restic-ls.1 +++ b/doc/man/restic-ls.1 @@ -33,7 +33,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -43,7 +46,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--human-readable\fP[=false] @@ -53,9 +56,13 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB-l\fP, \fB--long\fP[=false] use a long listing format showing size and mode +.PP +\fB--ncdu\fP[=false] + output NCDU export format (pipe into 'ncdu -f -') + .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times, snapshots must include all specified paths) .PP \fB--recursive\fP[=false] @@ -83,6 +90,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-migrate.1 b/doc/man/restic-migrate.1 index 7e48f726c..2272294bf 100644 --- a/doc/man/restic-migrate.1 +++ b/doc/man/restic-migrate.1 @@ -20,7 +20,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -50,6 +53,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-mount.1 b/doc/man/restic-mount.1 index aab607fcf..a256d2a5f 100644 --- a/doc/man/restic-mount.1 +++ b/doc/man/restic-mount.1 @@ -28,7 +28,6 @@ Example time template without colons: .EX --time-template "2006-01-02_15-04-05" - .EE .PP @@ -36,7 +35,6 @@ You need to specify a sample format for exactly the following timestamp: .EX Mon Jan 2 15:04:05 -0700 MST 2006 - .EE .PP @@ -62,7 +60,10 @@ The default path templates are: .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -76,7 +77,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--no-default-permissions\fP[=false] @@ -88,7 +89,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--path-template\fP=[] @@ -120,6 +121,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-prune.1 b/doc/man/restic-prune.1 index c54d5d7ff..7e16748ab 100644 --- a/doc/man/restic-prune.1 +++ b/doc/man/restic-prune.1 @@ -19,7 +19,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -73,6 +76,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-recover.1 b/doc/man/restic-recover.1 index 010fbafd7..0529360ae 100644 --- a/doc/man/restic-recover.1 +++ b/doc/man/restic-recover.1 @@ -20,7 +20,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -46,6 +49,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-repair-index.1 b/doc/man/restic-repair-index.1 index f06be64c0..60327a916 100644 --- a/doc/man/restic-repair-index.1 +++ b/doc/man/restic-repair-index.1 @@ -19,7 +19,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -49,6 +52,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-repair-packs.1 b/doc/man/restic-repair-packs.1 index f3671fe18..01a2f6540 100644 --- a/doc/man/restic-repair-packs.1 +++ b/doc/man/restic-repair-packs.1 @@ -12,9 +12,6 @@ restic-repair-packs - Salvage damaged pack files .SH DESCRIPTION -.PP -WARNING: The CLI for this command is experimental and will likely change in the future! - .PP The "repair packs" command extracts intact blobs from the specified pack files, rebuilds the index to remove the damaged pack files and removes the pack files from the repository. @@ -22,7 +19,10 @@ the index to remove the damaged pack files and removes the pack files from the r .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -48,6 +48,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-repair-snapshots.1 b/doc/man/restic-repair-snapshots.1 index 9369f25f2..c4439f131 100644 --- a/doc/man/restic-repair-snapshots.1 +++ b/doc/man/restic-repair-snapshots.1 @@ -37,7 +37,10 @@ snapshot! .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -55,11 +58,11 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] @@ -83,6 +86,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-repair.1 b/doc/man/restic-repair.1 index 77aecc173..7fa313aab 100644 --- a/doc/man/restic-repair.1 +++ b/doc/man/restic-repair.1 @@ -39,6 +39,14 @@ Repair the repository \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-restore.1 b/doc/man/restic-restore.1 index 4635b1e43..876b18bf8 100644 --- a/doc/man/restic-restore.1 +++ b/doc/man/restic-restore.1 @@ -21,43 +21,74 @@ The special snapshotID "latest" can be used to restore the latest snapshot in th repository. .PP -To only restore a specific subfolder, you can use the ":" +To only restore a specific subfolder, you can use the "snapshotID:subfolder" syntax, where "subfolder" is a path within the snapshot. .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS +.PP +\fB--delete\fP[=false] + delete files from target directory if they do not exist in snapshot. Use '--dry-run -vv' to check what would be deleted + +.PP +\fB--dry-run\fP[=false] + do not write any data, just show what would be done + .PP \fB-e\fP, \fB--exclude\fP=[] exclude a \fBpattern\fR (can be specified multiple times) +.PP +\fB--exclude-file\fP=[] + read exclude patterns from a \fBfile\fR (can be specified multiple times) + .PP \fB-h\fP, \fB--help\fP[=false] help for restore .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--iexclude\fP=[] - same as --exclude but ignores the casing of \fBpattern\fR + same as --exclude \fBpattern\fR but ignores the casing of filenames + +.PP +\fB--iexclude-file\fP=[] + same as --exclude-file but ignores casing of \fBfile\fRnames in patterns .PP \fB--iinclude\fP=[] - same as --include but ignores the casing of \fBpattern\fR + same as --include \fBpattern\fR but ignores the casing of filenames + +.PP +\fB--iinclude-file\fP=[] + same as --include-file but ignores casing of \fBfile\fRnames in patterns .PP \fB-i\fP, \fB--include\fP=[] - include a \fBpattern\fR, exclude everything else (can be specified multiple times) + include a \fBpattern\fR (can be specified multiple times) + +.PP +\fB--include-file\fP=[] + read include patterns from a \fBfile\fR (can be specified multiple times) + +.PP +\fB--overwrite\fP=always + overwrite behavior, one of (always|if-changed|if-newer|never) (default: always) .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR, when snapshot ID "latest" is given (can be specified multiple times, snapshots must include all specified paths) .PP \fB--sparse\fP[=false] @@ -93,6 +124,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-rewrite.1 b/doc/man/restic-rewrite.1 index d63c653e6..d3dd92436 100644 --- a/doc/man/restic-rewrite.1 +++ b/doc/man/restic-rewrite.1 @@ -35,7 +35,10 @@ use the "prune" command. .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -61,7 +64,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--iexclude\fP=[] @@ -71,9 +74,17 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--iexclude-file\fP=[] same as --exclude-file but ignores casing of \fBfile\fRnames in patterns +.PP +\fB--new-host\fP="" + replace hostname + +.PP +\fB--new-time\fP="" + replace time of the backup + .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] @@ -97,6 +108,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-self-update.1 b/doc/man/restic-self-update.1 index 92ab5add3..e6dd4faf2 100644 --- a/doc/man/restic-self-update.1 +++ b/doc/man/restic-self-update.1 @@ -21,7 +21,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -51,6 +54,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-snapshots.1 b/doc/man/restic-snapshots.1 index 6203bbf2b..25d5274e3 100644 --- a/doc/man/restic-snapshots.1 +++ b/doc/man/restic-snapshots.1 @@ -18,7 +18,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -36,7 +39,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--latest\fP=0 @@ -44,7 +47,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] @@ -68,6 +71,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-stats.1 b/doc/man/restic-stats.1 index 9d37163de..fe4074ca5 100644 --- a/doc/man/restic-stats.1 +++ b/doc/man/restic-stats.1 @@ -32,7 +32,7 @@ The modes are: .IP \(bu 2 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 unique 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 @@ -48,7 +48,10 @@ 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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -58,7 +61,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--mode\fP="restore-size" @@ -66,7 +69,7 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--tag\fP=[] @@ -90,6 +93,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-tag.1 b/doc/man/restic-tag.1 index b1468c74d..7ab1911e5 100644 --- a/doc/man/restic-tag.1 +++ b/doc/man/restic-tag.1 @@ -25,7 +25,10 @@ When no snapshotID is given, all snapshots matching the host, tag and path filte .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. +Exit status is 1 if there was any error. +Exit status is 10 if the repository does not exist. +Exit status is 11 if the repository is already locked. .SH OPTIONS @@ -39,11 +42,11 @@ Exit status is 0 if the command was successful, and non-zero if there was any er .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) + only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) .PP \fB--path\fP=[] - only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times) + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) .PP \fB--remove\fP=[] @@ -75,6 +78,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-unlock.1 b/doc/man/restic-unlock.1 index 0b3b43f2a..a24a4f815 100644 --- a/doc/man/restic-unlock.1 +++ b/doc/man/restic-unlock.1 @@ -18,7 +18,8 @@ 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. +Exit status is 1 if there was any error. .SH OPTIONS @@ -48,6 +49,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic-version.1 b/doc/man/restic-version.1 index ccc23038f..e9df439ed 100644 --- a/doc/man/restic-version.1 +++ b/doc/man/restic-version.1 @@ -19,7 +19,8 @@ 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. +Exit status is 1 if there was any error. .SH OPTIONS @@ -45,6 +46,14 @@ Exit status is 0 if the command was successful, and non-zero if there was any er \fB--compression\fP=auto compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/man/restic.1 b/doc/man/restic.1 index 333eab76a..ee423c6ad 100644 --- a/doc/man/restic.1 +++ b/doc/man/restic.1 @@ -41,6 +41,14 @@ The full documentation can be found at https://restic.readthedocs.io/ . \fB-h\fP, \fB--help\fP[=false] help for restic +.PP +\fB--http-user-agent\fP="" + set a http user agent for outgoing http requests + +.PP +\fB--insecure-no-password\fP[=false] + use an empty password for the repository, must be passed to every restic command (insecure) + .PP \fB--insecure-tls\fP[=false] skip TLS certificate verification when connecting to the repository (insecure) diff --git a/doc/powershell-completion.ps1 b/doc/powershell-completion.ps1 index d8aa5a1af..033477e7b 100644 --- a/doc/powershell-completion.ps1 +++ b/doc/powershell-completion.ps1 @@ -10,7 +10,7 @@ filter __restic_escapeStringWithSpecialChars { $_ -replace '\s|#|@|\$|;|,|''|\{|\}|\(|\)|"|`|\||<|>|&','`$&' } -[scriptblock]$__resticCompleterBlock = { +[scriptblock]${__resticCompleterBlock} = { param( $WordToComplete, $CommandAst, @@ -85,7 +85,7 @@ filter __restic_escapeStringWithSpecialChars { __restic_debug "Calling $RequestComp" # First disable ActiveHelp which is not supported for Powershell - $env:RESTIC_ACTIVE_HELP=0 + ${env:RESTIC_ACTIVE_HELP}=0 #call the command store the output in $out and redirect stderr and stdout to null # $Out is an array contains each line per element @@ -242,4 +242,4 @@ filter __restic_escapeStringWithSpecialChars { } } -Register-ArgumentCompleter -CommandName 'restic' -ScriptBlock $__resticCompleterBlock +Register-ArgumentCompleter -CommandName 'restic' -ScriptBlock ${__resticCompleterBlock}