From 3a2539e0ac0cfaa0e089db4bfeb974520631af85 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Sun, 24 Sep 2017 23:13:04 +0200 Subject: [PATCH] doc: Update manpages --- doc/man/restic-autocomplete.1 | 8 ++++++++ doc/man/restic-backup.1 | 8 ++++++++ doc/man/restic-cat.1 | 8 ++++++++ doc/man/restic-check.1 | 16 ++++++++++++++++ doc/man/restic-dump.1 | 8 ++++++++ doc/man/restic-find.1 | 8 ++++++++ doc/man/restic-forget.1 | 8 ++++++++ doc/man/restic-init.1 | 8 ++++++++ doc/man/restic-key.1 | 8 ++++++++ doc/man/restic-list.1 | 8 ++++++++ doc/man/restic-ls.1 | 8 ++++++++ doc/man/restic-manpage.1 | 8 ++++++++ doc/man/restic-migrate.1 | 8 ++++++++ doc/man/restic-mount.1 | 8 ++++++++ doc/man/restic-prune.1 | 8 ++++++++ doc/man/restic-rebuild-index.1 | 8 ++++++++ doc/man/restic-restore.1 | 8 ++++++++ doc/man/restic-snapshots.1 | 8 ++++++++ doc/man/restic-tag.1 | 8 ++++++++ doc/man/restic-unlock.1 | 8 ++++++++ doc/man/restic-version.1 | 8 ++++++++ doc/man/restic.1 | 8 ++++++++ 22 files changed, 184 insertions(+) diff --git a/doc/man/restic-autocomplete.1 b/doc/man/restic-autocomplete.1 index aeb3f4e72..f4450189e 100644 --- a/doc/man/restic-autocomplete.1 +++ b/doc/man/restic-autocomplete.1 @@ -40,10 +40,18 @@ $ sudo restic autocomplete .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-backup.1 b/doc/man/restic-backup.1 index 742adc928..fc3400645 100644 --- a/doc/man/restic-backup.1 +++ b/doc/man/restic-backup.1 @@ -78,10 +78,18 @@ given as the arguments. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-cat.1 b/doc/man/restic-cat.1 index 765943ad3..156cb8d32 100644 --- a/doc/man/restic-cat.1 +++ b/doc/man/restic-cat.1 @@ -25,10 +25,18 @@ The "cat" command is used to print internal objects to stdout. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-check.1 b/doc/man/restic-check.1 index 22493f8c6..2b6a3cb11 100644 --- a/doc/man/restic-check.1 +++ b/doc/man/restic-check.1 @@ -18,6 +18,10 @@ restic\-check \- Check the repository for errors 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. +.PP +By default, the "check" command will always load all data directly from the +repository and not use a local cache. + .SH OPTIONS .PP @@ -32,12 +36,24 @@ finds. It can also be used to read all data and therefore simulate a restore. \fB\-\-read\-data\fP[=false] read all data blobs +.PP +\fB\-\-with\-cache\fP[=false] + use the cache + .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-dump.1 b/doc/man/restic-dump.1 index 32d5e4ce8..afab6f159 100644 --- a/doc/man/restic-dump.1 +++ b/doc/man/restic-dump.1 @@ -26,10 +26,18 @@ is used for debugging purposes only. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-find.1 b/doc/man/restic-find.1 index 89d31242d..1c0ac962d 100644 --- a/doc/man/restic-find.1 +++ b/doc/man/restic-find.1 @@ -58,10 +58,18 @@ repo. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-forget.1 b/doc/man/restic-forget.1 index 0a18e93f5..06ac56dcb 100644 --- a/doc/man/restic-forget.1 +++ b/doc/man/restic-forget.1 @@ -88,10 +88,18 @@ data after 'forget' was run successfully, see the 'prune' command. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-init.1 b/doc/man/restic-init.1 index f7d0be5af..ece3db2bc 100644 --- a/doc/man/restic-init.1 +++ b/doc/man/restic-init.1 @@ -25,10 +25,18 @@ The "init" command initializes a new repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-key.1 b/doc/man/restic-key.1 index bc0664452..81f4abf04 100644 --- a/doc/man/restic-key.1 +++ b/doc/man/restic-key.1 @@ -25,10 +25,18 @@ The "key" command manages keys (passwords) for accessing the repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-list.1 b/doc/man/restic-list.1 index ccc1e8b0f..92793f6c7 100644 --- a/doc/man/restic-list.1 +++ b/doc/man/restic-list.1 @@ -25,10 +25,18 @@ The "list" command allows listing objects in the repository based on type. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-ls.1 b/doc/man/restic-ls.1 index 8f81194c0..e0dae4e21 100644 --- a/doc/man/restic-ls.1 +++ b/doc/man/restic-ls.1 @@ -44,10 +44,18 @@ The special snapshot\-ID "latest" can be used to list files and directories of t .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-manpage.1 b/doc/man/restic-manpage.1 index d8d1bcc30..6f9d5f898 100644 --- a/doc/man/restic-manpage.1 +++ b/doc/man/restic-manpage.1 @@ -31,10 +31,18 @@ set and no command is specified, all manpages are written to the directory. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-migrate.1 b/doc/man/restic-migrate.1 index f65a0aae5..b8a90a854 100644 --- a/doc/man/restic-migrate.1 +++ b/doc/man/restic-migrate.1 @@ -30,10 +30,18 @@ name is explicitly given, a list of migrations that can be applied is printed. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-mount.1 b/doc/man/restic-mount.1 index edf3e4da3..324208067 100644 --- a/doc/man/restic-mount.1 +++ b/doc/man/restic-mount.1 @@ -50,10 +50,18 @@ read\-only mount. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-prune.1 b/doc/man/restic-prune.1 index dfe390fe2..fde9a69d8 100644 --- a/doc/man/restic-prune.1 +++ b/doc/man/restic-prune.1 @@ -26,10 +26,18 @@ referenced and therefore not needed any more. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-rebuild-index.1 b/doc/man/restic-rebuild-index.1 index f406f8bc6..83baa4509 100644 --- a/doc/man/restic-rebuild-index.1 +++ b/doc/man/restic-rebuild-index.1 @@ -26,10 +26,18 @@ repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-restore.1 b/doc/man/restic-restore.1 index 86fcbbfc3..bef55324b 100644 --- a/doc/man/restic-restore.1 +++ b/doc/man/restic-restore.1 @@ -54,10 +54,18 @@ repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-snapshots.1 b/doc/man/restic-snapshots.1 index 21e9d9536..c71f16b3a 100644 --- a/doc/man/restic-snapshots.1 +++ b/doc/man/restic-snapshots.1 @@ -41,10 +41,18 @@ The "snapshots" command lists all snapshots stored in the repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-tag.1 b/doc/man/restic-tag.1 index 890fdad0b..031922ea8 100644 --- a/doc/man/restic-tag.1 +++ b/doc/man/restic-tag.1 @@ -56,10 +56,18 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-unlock.1 b/doc/man/restic-unlock.1 index 9b520d4b3..19430880c 100644 --- a/doc/man/restic-unlock.1 +++ b/doc/man/restic-unlock.1 @@ -29,10 +29,18 @@ The "unlock" command removes stale locks that have been created by other restic .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic-version.1 b/doc/man/restic-version.1 index 03599f39d..e1a8c2782 100644 --- a/doc/man/restic-version.1 +++ b/doc/man/restic-version.1 @@ -26,10 +26,18 @@ and the version of this software. .SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos diff --git a/doc/man/restic.1 b/doc/man/restic.1 index 492cf4c56..a07af6bd5 100644 --- a/doc/man/restic.1 +++ b/doc/man/restic.1 @@ -20,6 +20,10 @@ directories in an encrypted repository stored on different backends. .SH OPTIONS +.PP +\fB\-\-cache\-dir\fP="" + set the cache directory + .PP \fB\-h\fP, \fB\-\-help\fP[=false] help for restic @@ -28,6 +32,10 @@ directories in an encrypted repository stored on different backends. \fB\-\-json\fP[=false] set output mode to JSON for commands that support it +.PP +\fB\-\-no\-cache\fP[=false] + do not use a local cache + .PP \fB\-\-no\-lock\fP[=false] do not lock the repo, this allows some operations on read\-only repos