Update manpages and auto-completion

2025-08-12 11:17:42 +00:00 · 2017-12-27 22:31:03 +01:00
parent f6ed7dc013
commit 6ecd14d780
24 changed files with 244 additions and 2 deletions
--- a/doc/man/restic-backup.1
+++ b/doc/man/restic-backup.1
@@ -76,6 +76,10 @@ given as the arguments.
 \fB\-\-time\fP=""
    time of the backup (ex. '2012\-11\-01 22:08:41') (default: now)

+.PP
+\fB\-\-with\-atime\fP[=false]
+    store the atime for all files and directories
+

 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
@@ -86,6 +90,10 @@ given as the arguments.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-cat.1
+++ b/doc/man/restic-cat.1
@@ -33,6 +33,10 @@ The "cat" command is used to print internal objects to stdout.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-check.1
+++ b/doc/man/restic-check.1
@@ -50,6 +50,10 @@ repository and not use a local cache.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-diff.1
+++ b/doc/man/restic-diff.1
@@ -0,0 +1,92 @@
+.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+restic\-diff \- Show differences between two snapshots
+
+
+.SH SYNOPSIS
+.PP
+\fBrestic diff snapshot\-ID snapshot\-ID [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+The "diff" command shows differences from the first to the second snapshot. The
+first characters in each line display what has happened to a particular file or
+directory:
+.IP \(bu 2
+The item was added
+.IP \(bu 2
+The item was removed
+U  The metadata (access mode, timestamps, ...) for the item was updated
+M  The file's content was modified
+T  The type was changed, e.g. a file was made a symlink
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for diff
+
+.PP
+\fB\-\-metadata\fP[=false]
+    print changes in metadata
+
+
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
+.PP
+\fB\-\-cacert\fP=[]
+    path to load root certificates from (default: use system certificates)
+
+.PP
+\fB\-\-cache\-dir\fP=""
+    set the cache directory
+
+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
+.PP
+\fB\-\-json\fP[=false]
+    set output mode to JSON for commands that support it
+
+.PP
+\fB\-\-limit\-download\fP=0
+    limits downloads to a maximum rate in KiB/s. (default: unlimited)
+
+.PP
+\fB\-\-limit\-upload\fP=0
+    limits uploads to a maximum rate in KiB/s. (default: unlimited)
+
+.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
+
+.PP
+\fB\-o\fP, \fB\-\-option\fP=[]
+    set extended option (\fB\fCkey=value\fR, can be specified multiple times)
+
+.PP
+\fB\-p\fP, \fB\-\-password\-file\fP=""
+    read the repository password from a file (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=""
+    repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
+
+
+.SH SEE ALSO
+.PP
+\fBrestic(1)\fP
--- a/doc/man/restic-dump.1
+++ b/doc/man/restic-dump.1
@@ -50,6 +50,10 @@ repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-find.1
+++ b/doc/man/restic-find.1
@@ -66,6 +66,10 @@ repo.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-forget.1
+++ b/doc/man/restic-forget.1
@@ -96,6 +96,10 @@ data after 'forget' was run successfully, see the 'prune' command.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-generate.1
+++ b/doc/man/restic-generate.1
@@ -46,6 +46,10 @@ and the auto\-completion files for bash and zsh).
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-init.1
+++ b/doc/man/restic-init.1
@@ -33,6 +33,10 @@ The "init" command initializes a new repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-key.1
+++ b/doc/man/restic-key.1
@@ -33,6 +33,10 @@ The "key" command manages keys (passwords) for accessing the repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-list.1
+++ b/doc/man/restic-list.1
@@ -33,6 +33,10 @@ The "list" command allows listing objects in the repository based on type.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-ls.1
+++ b/doc/man/restic-ls.1
@@ -52,6 +52,10 @@ The special snapshot\-ID "latest" can be used to list files and directories of t
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-migrate.1
+++ b/doc/man/restic-migrate.1
@@ -38,6 +38,10 @@ name is explicitly given, a list of migrations that can be applied is printed.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-mount.1
+++ b/doc/man/restic-mount.1
@@ -58,6 +58,10 @@ read\-only mount.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-prune.1
+++ b/doc/man/restic-prune.1
@@ -34,6 +34,10 @@ referenced and therefore not needed any more.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-rebuild-index.1
+++ b/doc/man/restic-rebuild-index.1
@@ -34,6 +34,10 @@ repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-restore.1
+++ b/doc/man/restic-restore.1
@@ -62,6 +62,10 @@ repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-snapshots.1
+++ b/doc/man/restic-snapshots.1
@@ -53,6 +53,10 @@ The "snapshots" command lists all snapshots stored in the repository.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-tag.1
+++ b/doc/man/restic-tag.1
@@ -64,6 +64,10 @@ When no snapshot\-ID is given, all snapshots matching the host, tag and path fil
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-unlock.1
+++ b/doc/man/restic-unlock.1
@@ -37,6 +37,10 @@ The "unlock" command removes stale locks that have been created by other restic
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic-version.1
+++ b/doc/man/restic-version.1
@@ -34,6 +34,10 @@ and the version of this software.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it
--- a/doc/man/restic.1
+++ b/doc/man/restic.1
@@ -28,6 +28,10 @@ directories in an encrypted repository stored on different backends.
 \fB\-\-cache\-dir\fP=""
    set the cache directory

+.PP
+\fB\-\-cleanup\-cache\fP[=false]
+    auto remove old cache directories
+
 .PP
 \fB\-h\fP, \fB\-\-help\fP[=false]
    help for restic
@@ -71,4 +75,4 @@ directories in an encrypted repository stored on different backends.

 .SH SEE ALSO
 .PP
-\fBrestic\-backup(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP
+\fBrestic\-backup(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-diff(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP