diff --git a/doc/bash-completion.sh b/doc/bash-completion.sh index 5103d80c0..cb66db4b8 100644 --- a/doc/bash-completion.sh +++ b/doc/bash-completion.sh @@ -703,12 +703,26 @@ _restic_check() flags+=("-h") local_nonpersistent_flags+=("--help") local_nonpersistent_flags+=("-h") + flags+=("--host=") + two_word_flags+=("--host") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host") + local_nonpersistent_flags+=("--host=") + local_nonpersistent_flags+=("-H") + flags+=("--path=") + two_word_flags+=("--path") + local_nonpersistent_flags+=("--path") + local_nonpersistent_flags+=("--path=") flags+=("--read-data") local_nonpersistent_flags+=("--read-data") flags+=("--read-data-subset=") two_word_flags+=("--read-data-subset") local_nonpersistent_flags+=("--read-data-subset") local_nonpersistent_flags+=("--read-data-subset=") + flags+=("--tag=") + two_word_flags+=("--tag") + local_nonpersistent_flags+=("--tag") + local_nonpersistent_flags+=("--tag=") flags+=("--with-cache") local_nonpersistent_flags+=("--with-cache") flags+=("--cacert=") @@ -1349,8 +1363,6 @@ _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+=("--repack-smaller-than=") @@ -2570,8 +2582,6 @@ _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-smaller-than=") two_word_flags+=("--repack-smaller-than") local_nonpersistent_flags+=("--repack-smaller-than") @@ -3153,6 +3163,8 @@ _restic_restore() two_word_flags+=("--overwrite") local_nonpersistent_flags+=("--overwrite") local_nonpersistent_flags+=("--overwrite=") + flags+=("--ownership-by-name") + local_nonpersistent_flags+=("--ownership-by-name") flags+=("--path=") two_word_flags+=("--path") local_nonpersistent_flags+=("--path") @@ -3271,6 +3283,24 @@ _restic_rewrite() 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+=("--new-host=") two_word_flags+=("--new-host") local_nonpersistent_flags+=("--new-host") diff --git a/doc/man/restic-backup.1 b/doc/man/restic-backup.1 index 8b4e1a9d1..19483cb55 100644 --- a/doc/man/restic-backup.1 +++ b/doc/man/restic-backup.1 @@ -150,7 +150,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-cache.1 b/doc/man/restic-cache.1 index 068aad681..b13f27484 100644 --- a/doc/man/restic-cache.1 +++ b/doc/man/restic-cache.1 @@ -49,7 +49,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-cat.1 b/doc/man/restic-cat.1 index cc774cf77..dffd41658 100644 --- a/doc/man/restic-cat.1 +++ b/doc/man/restic-cat.1 @@ -40,7 +40,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-check.1 b/doc/man/restic-check.1 index 9e24ac693..7bcbb50e4 100644 --- a/doc/man/restic-check.1 +++ b/doc/man/restic-check.1 @@ -11,11 +11,16 @@ restic-check - Check the repository for errors .SH DESCRIPTION The "check" command tests the repository for errors and reports any errors it -finds. It can also be used to read all data and therefore simulate a restore. +finds. .PP -By default, the "check" command will always load all data directly from the -repository and not use a local cache. +By default, check verifies the structural consistency and integrity of +snapshots, trees and pack files. To also verify the integrity of the actual +backed-up data, use the --read-data or --read-data-subset flags. + +.PP +By default, check creates a new temporary cache directory to verify data. +To reuse the existing cache, use the --with-cache flag. .SH EXIT STATUS @@ -30,6 +35,14 @@ Exit status is 12 if the password is incorrect. \fB-h\fP, \fB--help\fP[=false] help for check +.PP +\fB-H\fP, \fB--host\fP=[] + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) + +.PP +\fB--path\fP=[] + only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths) + .PP \fB--read-data\fP[=false] read all data blobs @@ -38,6 +51,10 @@ Exit status is 12 if the password is incorrect. \fB--read-data-subset\fP="" read a \fBsubset\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--tag\fP=[] + only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times) + .PP \fB--with-cache\fP[=false] use existing cache, only read uncached data from repository @@ -57,7 +74,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-copy.1 b/doc/man/restic-copy.1 index aa38f5ffd..952af3c24 100644 --- a/doc/man/restic-copy.1 +++ b/doc/man/restic-copy.1 @@ -65,7 +65,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--path\fP=[] @@ -90,7 +90,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-diff.1 b/doc/man/restic-diff.1 index 163b54478..499775e34 100644 --- a/doc/man/restic-diff.1 +++ b/doc/man/restic-diff.1 @@ -33,7 +33,7 @@ Metadata comparison will likely not work if a backup was created using the .PP To only compare files in specific subfolders, you can use the "snapshotID:subfolder" syntax, where "subfolder" is a path within the -snapshot. +snapshot tree as shown by "restic ls". .SH EXIT STATUS @@ -67,7 +67,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-dump.1 b/doc/man/restic-dump.1 index e4a6126c2..71b13a451 100644 --- a/doc/man/restic-dump.1 +++ b/doc/man/restic-dump.1 @@ -2,7 +2,7 @@ .TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" .SH NAME -restic-dump - Print a backed-up file to stdout +restic-dump - Print backed-up files or folders to stdout .SH SYNOPSIS @@ -22,7 +22,7 @@ repository. .PP To include the folder content at the root of the archive, you can use the "snapshotID:subfolder" syntax, where "subfolder" is a path within the -snapshot. +snapshot tree as shown by "restic ls". .SH EXIT STATUS @@ -43,7 +43,7 @@ Exit status is 12 if the password is incorrect. .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) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--path\fP=[] @@ -72,7 +72,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-features.1 b/doc/man/restic-features.1 index 355b17782..ea5351324 100644 --- a/doc/man/restic-features.1 +++ b/doc/man/restic-features.1 @@ -48,7 +48,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-find.1 b/doc/man/restic-find.1 index 9a7517922..56288caf3 100644 --- a/doc/man/restic-find.1 +++ b/doc/man/restic-find.1 @@ -11,12 +11,22 @@ restic-find - Find a file, a directory or restic IDs .SH DESCRIPTION The "find" command searches for files or directories in snapshots stored in the -repo. -It can also be used to search for restic blobs or trees for troubleshooting. +repository. It can also be used to search for restic blobs, trees or pack +files for troubleshooting. + +.PP The default sort option for the snapshots is youngest to oldest. To sort the output from oldest to youngest specify --reverse. +.SH EXIT STATUS +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. +Exit status is 12 if the password is incorrect. + + .SH OPTIONS \fB--blob\fP[=false] pattern is a blob-ID @@ -27,7 +37,7 @@ output from oldest to youngest specify --reverse. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--human-readable\fP[=false] @@ -92,7 +102,7 @@ output from oldest to youngest specify --reverse. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" @@ -187,16 +197,6 @@ 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. -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. -Exit status is 12 if the password is incorrect. - .EE diff --git a/doc/man/restic-forget.1 b/doc/man/restic-forget.1 index 0ac6dc990..73583fcbd 100644 --- a/doc/man/restic-forget.1 +++ b/doc/man/restic-forget.1 @@ -30,6 +30,7 @@ security considerations. .SH EXIT STATUS Exit status is 0 if the command was successful. Exit status is 1 if there was any error. +Exit status is 3 if there was an error removing one or more snapshots. Exit status is 10 if the repository does not exist. Exit status is 11 if the repository is already locked. Exit status is 12 if the password is incorrect. @@ -93,7 +94,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--tag\fP=[] @@ -131,17 +132,13 @@ Exit status is 12 if the password is incorrect. \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--repack-smaller-than\fP="" - pack \fBbelow-limit\fR packfiles (allowed suffixes: k/K, m/M) + pack \fBbelow-limit\fR packfiles (allowed suffixes: m/M) .PP \fB-h\fP, \fB--help\fP[=false] @@ -162,7 +159,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-generate.1 b/doc/man/restic-generate.1 index 1b4f935e6..2d50cc572 100644 --- a/doc/man/restic-generate.1 +++ b/doc/man/restic-generate.1 @@ -11,7 +11,7 @@ restic-generate - Generate manual pages and auto-completion files (bash, fish, z .SH DESCRIPTION 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, powershell and zsh). .SH EXIT STATUS @@ -58,7 +58,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-init.1 b/doc/man/restic-init.1 index 2f2db28be..38fbe3abc 100644 --- a/doc/man/restic-init.1 +++ b/doc/man/restic-init.1 @@ -69,7 +69,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-key-add.1 b/doc/man/restic-key-add.1 index 49d65169a..6ce20d547 100644 --- a/doc/man/restic-key-add.1 +++ b/doc/man/restic-key-add.1 @@ -10,7 +10,7 @@ restic-key-add - Add a new key (password) to the repository; returns the new key .SH DESCRIPTION -The "add" sub-command creates a new key and validates the key. Returns the new key ID. +The "key add" command creates a new key and validates the key. Returns the new key ID. .SH EXIT STATUS @@ -56,7 +56,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-key-list.1 b/doc/man/restic-key-list.1 index d14b4e1fe..9356a7160 100644 --- a/doc/man/restic-key-list.1 +++ b/doc/man/restic-key-list.1 @@ -10,7 +10,7 @@ restic-key-list - List keys (passwords) .SH DESCRIPTION -The "list" sub-command lists all the keys (passwords) associated with the repository. +The "key list" 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. @@ -42,7 +42,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-key-passwd.1 b/doc/man/restic-key-passwd.1 index b70ea7c8b..ef7e6058d 100644 --- a/doc/man/restic-key-passwd.1 +++ b/doc/man/restic-key-passwd.1 @@ -10,7 +10,7 @@ restic-key-passwd - Change key (password); creates a new key ID and removes the .SH DESCRIPTION -The "passwd" sub-command creates a new key, validates the key and remove the old key ID. +The "key passwd" command creates a new key, validates the key and removes the old key ID. Returns the new key ID. @@ -57,7 +57,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-key-remove.1 b/doc/man/restic-key-remove.1 index daf9c97b5..7c5c4ccfe 100644 --- a/doc/man/restic-key-remove.1 +++ b/doc/man/restic-key-remove.1 @@ -2,7 +2,7 @@ .TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" .SH NAME -restic-key-remove - Remove key ID (password) from the repository. +restic-key-remove - Remove key ID (password) from the repository .SH SYNOPSIS @@ -10,8 +10,8 @@ restic-key-remove - Remove key ID (password) from the repository. .SH DESCRIPTION -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. +The "key remove" command removes the selected key ID. It does not allow removing the +current key being used to access the repository. .SH EXIT STATUS @@ -41,7 +41,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-key.1 b/doc/man/restic-key.1 index 101e0960a..7bdbddccc 100644 --- a/doc/man/restic-key.1 +++ b/doc/man/restic-key.1 @@ -33,7 +33,7 @@ per repository. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-list.1 b/doc/man/restic-list.1 index b585aca49..7a56ee2f3 100644 --- a/doc/man/restic-list.1 +++ b/doc/man/restic-list.1 @@ -40,7 +40,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-ls.1 b/doc/man/restic-ls.1 index 4e83d2f1a..9e28a123d 100644 --- a/doc/man/restic-ls.1 +++ b/doc/man/restic-ls.1 @@ -47,7 +47,7 @@ Exit status is 12 if the password is incorrect. .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) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--human-readable\fP[=false] @@ -96,7 +96,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-migrate.1 b/doc/man/restic-migrate.1 index a85f65b0e..db3c0ec52 100644 --- a/doc/man/restic-migrate.1 +++ b/doc/man/restic-migrate.1 @@ -46,7 +46,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-mount.1 b/doc/man/restic-mount.1 index d75f04ee3..7a03091b3 100644 --- a/doc/man/restic-mount.1 +++ b/doc/man/restic-mount.1 @@ -10,8 +10,8 @@ restic-mount - Mount the repository .SH DESCRIPTION -The "mount" command mounts the repository via fuse to a directory. This is a -read-only mount. +The "mount" command mounts the repository read-only via FUSE at the given +mountpoint. .SH Snapshot Directories @@ -72,7 +72,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--no-default-permissions\fP[=false] @@ -113,7 +113,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-options.1 b/doc/man/restic-options.1 index f22aa7b1a..310682b7f 100644 --- a/doc/man/restic-options.1 +++ b/doc/man/restic-options.1 @@ -37,7 +37,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-prune.1 b/doc/man/restic-prune.1 index a09735be6..3364ebb14 100644 --- a/doc/man/restic-prune.1 +++ b/doc/man/restic-prune.1 @@ -42,13 +42,9 @@ Exit status is 12 if the password is incorrect. \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-smaller-than\fP="" - pack \fBbelow-limit\fR packfiles (allowed suffixes: k/K, m/M) + pack \fBbelow-limit\fR packfiles (allowed suffixes: m/M) .PP \fB--repack-uncompressed\fP[=false] @@ -73,7 +69,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-recover.1 b/doc/man/restic-recover.1 index 73ea9cca2..10179150e 100644 --- a/doc/man/restic-recover.1 +++ b/doc/man/restic-recover.1 @@ -42,7 +42,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-repair-index.1 b/doc/man/restic-repair-index.1 index 5a49f5440..4a9d7e5a7 100644 --- a/doc/man/restic-repair-index.1 +++ b/doc/man/restic-repair-index.1 @@ -45,7 +45,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-repair-packs.1 b/doc/man/restic-repair-packs.1 index a463b87a8..c2756b428 100644 --- a/doc/man/restic-repair-packs.1 +++ b/doc/man/restic-repair-packs.1 @@ -41,7 +41,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-repair-snapshots.1 b/doc/man/restic-repair-snapshots.1 index 66c513b66..20e080a81 100644 --- a/doc/man/restic-repair-snapshots.1 +++ b/doc/man/restic-repair-snapshots.1 @@ -53,7 +53,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--path\fP=[] @@ -78,7 +78,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-repair.1 b/doc/man/restic-repair.1 index f3d8a3318..0438bd670 100644 --- a/doc/man/restic-repair.1 +++ b/doc/man/restic-repair.1 @@ -10,7 +10,8 @@ restic-repair - Repair the repository .SH DESCRIPTION -Repair the repository +The "repair" command repairs damaged repositories. It provides subcommands to +rebuild the index, salvage damaged pack files, and repair broken snapshots. .SH OPTIONS @@ -32,7 +33,7 @@ Repair the repository .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-restore.1 b/doc/man/restic-restore.1 index 2f34639e9..c281038c5 100644 --- a/doc/man/restic-restore.1 +++ b/doc/man/restic-restore.1 @@ -19,7 +19,11 @@ repository. .PP To only restore a specific subfolder, you can use the "snapshotID:subfolder" -syntax, where "subfolder" is a path within the snapshot. +syntax, where "subfolder" is a path within the snapshot tree as shown by +"restic ls". + +.PP +POSIX ACLs are always restored by their numeric value, while file ownership can optionally be restored by name instead of numeric value. .SH EXIT STATUS @@ -56,7 +60,7 @@ Exit status is 12 if the password is incorrect. .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) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR, when snapshot ID "latest" is given (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--iexclude\fP=[] @@ -90,6 +94,10 @@ Exit status is 12 if the password is incorrect. \fB--overwrite\fP=always overwrite behavior, one of (always|if-changed|if-newer|never) +.PP +\fB--ownership-by-name\fP[=false] + restore file ownership by user name and group name (except POSIX ACLs) + .PP \fB--path\fP=[] 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) @@ -125,7 +133,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-rewrite.1 b/doc/man/restic-rewrite.1 index dc085a8a3..b70c87523 100644 --- a/doc/man/restic-rewrite.1 +++ b/doc/man/restic-rewrite.1 @@ -2,7 +2,7 @@ .TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" "" .SH NAME -restic-rewrite - Rewrite snapshots to exclude unwanted files +restic-rewrite - Rewrite snapshots to exclude files or change metadata .SH SYNOPSIS @@ -10,9 +10,10 @@ restic-rewrite - Rewrite snapshots to exclude unwanted files .SH DESCRIPTION -The "rewrite" command excludes files from existing snapshots. It creates new -snapshots containing the same data as the original ones, but without the files -you specify to exclude. All metadata (time, host, tags) will be preserved. +The "rewrite" command creates new snapshots from existing ones. You can use +exclude or include filters to control which files are included in the new +snapshots. Unless --new-host or --new-time is specified, metadata (time, host, +tags) is preserved. .PP The snapshots to rewrite are specified using the --host, --tag and --path options, @@ -35,8 +36,8 @@ created containing statistics summary data. Only two fields in the summary will be non-zero: TotalFilesProcessed and TotalBytesProcessed. .PP -When rewrite is called with one of the --exclude options, TotalFilesProcessed -and TotalBytesProcessed will be updated in the snapshot summary. +When rewrite is called with one of the --exclude or --include options, +TotalFilesProcessed and TotalBytesProcessed will be updated in the snapshot summary. .SH EXIT STATUS @@ -69,7 +70,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--iexclude\fP=[] @@ -79,6 +80,22 @@ Exit status is 12 if the password is incorrect. \fB--iexclude-file\fP=[] same as --exclude-file but ignores casing of \fBfile\fRnames in patterns +.PP +\fB--iinclude\fP=[] + 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 (can be specified multiple times) + +.PP +\fB--include-file\fP=[] + read include patterns from a \fBfile\fR (can be specified multiple times) + .PP \fB--new-host\fP="" replace hostname @@ -114,7 +131,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-self-update.1 b/doc/man/restic-self-update.1 index 59064c6d1..d629e67a4 100644 --- a/doc/man/restic-self-update.1 +++ b/doc/man/restic-self-update.1 @@ -10,7 +10,7 @@ restic-self-update - Update the restic binary .SH DESCRIPTION -The command "self-update" downloads the latest stable release of restic from +The "self-update" command 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. @@ -19,9 +19,6 @@ files. .SH EXIT STATUS 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. -Exit status is 12 if the password is incorrect. .SH OPTIONS @@ -47,7 +44,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-snapshots.1 b/doc/man/restic-snapshots.1 index 1f61476e4..2a146f8c5 100644 --- a/doc/man/restic-snapshots.1 +++ b/doc/man/restic-snapshots.1 @@ -35,7 +35,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--latest\fP=0 @@ -64,7 +64,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-stats.1 b/doc/man/restic-stats.1 index 1e0c944c6..104ee386c 100644 --- a/doc/man/restic-stats.1 +++ b/doc/man/restic-stats.1 @@ -53,7 +53,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--mode\fP="restore-size" @@ -82,7 +82,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-tag.1 b/doc/man/restic-tag.1 index e7ba784b2..ad1178cbc 100644 --- a/doc/man/restic-tag.1 +++ b/doc/man/restic-tag.1 @@ -10,7 +10,7 @@ restic-tag - Modify tags on snapshots .SH DESCRIPTION -The "tag" command allows you to modify tags on exiting snapshots. +The "tag" command allows you to modify tags on existing snapshots. .PP You can either set/replace the entire set of tags on a snapshot, or @@ -38,7 +38,7 @@ Exit status is 12 if the password is incorrect. .PP \fB-H\fP, \fB--host\fP=[] - only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST) + only consider snapshots for this \fBhost\fR (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) .PP \fB--path\fP=[] @@ -71,7 +71,7 @@ Exit status is 12 if the password is incorrect. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-unlock.1 b/doc/man/restic-unlock.1 index fb709ed57..25fdd5c16 100644 --- a/doc/man/restic-unlock.1 +++ b/doc/man/restic-unlock.1 @@ -12,6 +12,9 @@ restic-unlock - Remove locks other processes created .SH DESCRIPTION The "unlock" command removes stale locks that have been created by other restic processes. +.PP +Removing locks works even with repositories served in append-only mode from restic's rest-server. + .SH EXIT STATUS Exit status is 0 if the command was successful. @@ -41,7 +44,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic-version.1 b/doc/man/restic-version.1 index d8244c63b..b3f537728 100644 --- a/doc/man/restic-version.1 +++ b/doc/man/restic-version.1 @@ -38,7 +38,7 @@ Exit status is 1 if there was any error. .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB--http-user-agent\fP="" diff --git a/doc/man/restic.1 b/doc/man/restic.1 index cff43c40d..7478c4822 100644 --- a/doc/man/restic.1 +++ b/doc/man/restic.1 @@ -31,7 +31,7 @@ The full documentation can be found at https://restic.readthedocs.io/ . .PP \fB--compression\fP=auto - compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) + compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) .PP \fB-h\fP, \fB--help\fP[=false]