restic/doc
Ryan Hitchman 77bf148460 backup: add --dry-run/-n flag to show what would happen.
This can be used to check how large a backup is or validate exclusions.
It does not actually write any data to the underlying backend. This is
implemented as a simple overlay backend that accepts writes without
forwarding them, passes through reads, and generally does the minimal
necessary to pretend that progress is actually happening.

Fixes #1542

Example usage:

$ restic -vv --dry-run . | grep add
new       /changelog/unreleased/issue-1542, saved in 0.000s (350 B added)
modified  /cmd/restic/cmd_backup.go, saved in 0.000s (16.543 KiB added)
modified  /cmd/restic/global.go, saved in 0.000s (0 B added)
new       /internal/backend/dry/dry_backend_test.go, saved in 0.000s (3.866 KiB added)
new       /internal/backend/dry/dry_backend.go, saved in 0.000s (3.744 KiB added)
modified  /internal/backend/test/tests.go, saved in 0.000s (0 B added)
modified  /internal/repository/repository.go, saved in 0.000s (20.707 KiB added)
modified  /internal/ui/backup.go, saved in 0.000s (9.110 KiB added)
modified  /internal/ui/jsonstatus/status.go, saved in 0.001s (11.055 KiB added)
modified  /restic, saved in 0.131s (25.542 MiB added)
Would add to the repo: 25.892 MiB
2021-08-04 21:19:29 +02:00
..
_static docs: switch to gopher favicon 2020-02-13 00:09:37 +01:00
images/aws_s3 Update AWS S3 tutorial, fixing #1593 2018-01-29 20:47:27 +01:00
logo Update logo 2018-02-05 20:48:48 +01:00
man Update manpages and auto-completion 2021-08-03 11:45:36 +02:00
.gitignore Document the build and release processes 2018-10-13 13:48:03 +02:00
010_introduction.rst Update docs 2018-04-28 22:08:11 +02:00
020_installation.rst bump cobra and add completions for fish 2021-05-21 13:47:52 +10:00
030_preparing_a_new_repo.rst doc: Add direct link to GitHub issue 2021-05-08 21:13:11 +00:00
040_backup.rst backup: add --dry-run/-n flag to show what would happen. 2021-08-04 21:19:29 +02:00
045_working_with_repos.rst Add repositoryFile2 option 2021-03-08 22:41:13 +01:00
050_restore.rst Some gramma fixes in documentation 2020-12-19 01:16:15 +03:00
060_forget.rst Allow --tag and --keep-tag to match untagged snapshots 2021-08-02 23:06:20 +02:00
070_encryption.rst Update docs 2018-04-28 22:08:11 +02:00
075_scripting.rst Update docs 2018-04-28 22:08:11 +02:00
080_examples.rst doc: Clarify setcap applying only to current binary 2021-03-08 19:21:06 +01:00
090_participating.rst Remove -mod=vendor from all documentation and code 2020-03-01 19:32:35 +01:00
100_references.rst doc: Split references out into smaller files 2018-06-18 22:17:48 +02:00
110_talks.rst Update docs 2018-04-28 22:08:11 +02:00
bash-completion.sh Update manpages and auto-completion 2021-08-03 11:45:36 +02:00
cache.rst Systematize documentation of environment variables 2020-10-22 09:57:30 +02:00
conf.py Update docs 2018-04-28 22:08:11 +02:00
design.rst doc: Fix grammar in design.rst 2021-04-14 17:25:53 -04:00
developer_information.rst docs: Properly reproduce zip archives for windows binaries 2020-10-05 18:24:46 +02:00
faq.rst Add FAQ on whether restic can resume backups 2020-10-03 21:39:45 +02:00
fish-completion.fish Update manpages and auto-completion 2021-08-03 11:45:36 +02:00
index.rst doc: Add developer information 2018-10-11 22:37:25 +02:00
Makefile Document the build and release processes 2018-10-13 13:48:03 +02:00
manual_rest.rst Allow --tag and --keep-tag to match untagged snapshots 2021-08-02 23:06:20 +02:00
requirements.txt Documentation: Refactor and switch to Sphinx 2017-04-17 20:53:38 +02:00
REST_backend.rst doc: Split references out into smaller files 2018-06-18 22:17:48 +02:00
test_irreducibility.gap chunker: Require a random irreducible polynomial 2015-04-05 22:52:43 +02:00
zsh-completion.zsh Update manpages and auto-completion 2021-08-03 11:45:36 +02:00