From face5bd7f7a9b9bdfa652ba1cf85b43c52dd1aa2 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 23 Apr 2023 15:06:11 +0200 Subject: [PATCH 1/2] Document that the compression mode can be set via $RESTIC_COMPRESSION --- cmd/restic/global.go | 2 +- doc/manual_rest.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/restic/global.go b/cmd/restic/global.go index 3e6c5f3a9..5063f7d6b 100644 --- a/cmd/restic/global.go +++ b/cmd/restic/global.go @@ -126,7 +126,7 @@ func init() { f.StringVar(&globalOptions.TLSClientCertKeyFilename, "tls-client-cert", "", "path to a `file` containing PEM encoded TLS client certificate and private key") f.BoolVar(&globalOptions.InsecureTLS, "insecure-tls", false, "skip TLS certificate verification when connecting to the repository (insecure)") f.BoolVar(&globalOptions.CleanupCache, "cleanup-cache", false, "auto remove old cache directories") - f.Var(&globalOptions.Compression, "compression", "compression mode (only available for repository format version 2), one of (auto|off|max)") + f.Var(&globalOptions.Compression, "compression", "compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)") f.IntVar(&globalOptions.Limits.UploadKb, "limit-upload", 0, "limits uploads to a maximum `rate` in KiB/s. (default: unlimited)") f.IntVar(&globalOptions.Limits.DownloadKb, "limit-download", 0, "limits downloads to a maximum `rate` in KiB/s. (default: unlimited)") f.UintVar(&globalOptions.PackSize, "pack-size", 0, "set target pack `size` in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)") diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 7f812f4e0..6bddd7ea3 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -50,7 +50,7 @@ Usage help is available: --cacert file file to load root certificates from (default: use system certificates) --cache-dir directory set the cache directory. (default: use system default cache directory) --cleanup-cache auto remove old cache directories - --compression mode compression mode (only available for repository format version 2), one of (auto|off|max) (default auto) + --compression mode compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) (default auto) -h, --help help for restic --insecure-tls skip TLS certificate verification when connecting to the repository (insecure) --json set output mode to JSON for commands that support it @@ -127,7 +127,7 @@ command: --cacert file file to load root certificates from (default: use system certificates) --cache-dir directory set the cache directory. (default: use system default cache directory) --cleanup-cache auto remove old cache directories - --compression mode compression mode (only available for repository format version 2), one of (auto|off|max) (default auto) + --compression mode compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION) (default auto) --insecure-tls skip TLS certificate verification when connecting to the repository (insecure) --json set output mode to JSON for commands that support it --key-hint key key ID of key to try decrypting first (default: $RESTIC_KEY_HINT) From 37d0e323eb664e594a0c534350c82b00a656dcd0 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 30 Apr 2023 16:12:29 +0200 Subject: [PATCH 2/2] doc: update help output in manual_rest.rst --- doc/manual_rest.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 6bddd7ea3..f812e3a70 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -26,7 +26,7 @@ Usage help is available: dump Print a backed-up file to stdout find Find a file, a directory or restic IDs forget Remove snapshots from the repository - generate Generate manual pages and auto-completion files (bash, fish, zsh) + generate Generate manual pages and auto-completion files (bash, fish, zsh, powershell) help Help about any command init Initialize a new repository key Manage keys (passwords) @@ -106,6 +106,7 @@ command: --files-from-raw file read the files to backup from file (can be combined with file args; can be specified multiple times) --files-from-verbatim file read the files to backup from file (can be combined with file args; can be specified multiple times) -f, --force force re-reading the target files/directories (overrides the "parent" flag) + -g, --group-by group group snapshots by host, paths and/or tags, separated by comma (disable grouping with '') (default host,paths) -h, --help help for backup -H, --host hostname set the hostname for the snapshot manually. To prevent an expensive rescan use the "parent" flag --iexclude pattern same as --exclude pattern but ignores the casing of filenames @@ -114,8 +115,8 @@ command: --ignore-inode ignore inode number changes when checking for modified files --no-scan do not run scanner to estimate size of backup -x, --one-file-system exclude other file systems, don't cross filesystem boundaries and subvolumes - --parent snapshot use this parent snapshot (default: last snapshot in the repository that has the same target files/directories, and is not newer than the snapshot time) - --read-concurrency n read n file concurrently (default: $RESTIC_READ_CONCURRENCY or 2) + --parent snapshot use this parent snapshot (default: latest snapshot in the group determined by --group-by and not newer than the timestamp determined by --time) + --read-concurrency n read n files concurrently (default: $RESTIC_READ_CONCURRENCY or 2) --stdin read backup from stdin --stdin-filename filename filename to use when reading from stdin (default "stdin") --tag tags add tags for the new snapshot in the format `tag[,tag,...]` (can be specified multiple times) (default [])