Clarify --files flag action in documentation (#554).

This commit is contained in:
Dan Helfman 2022-06-29 09:20:13 -07:00
parent bd4d109009
commit 2e0b2a308f

View file

@ -226,15 +226,20 @@ good idea to test that borgmatic is working. So to run borgmatic and start a
backup, you can invoke it like this: backup, you can invoke it like this:
```bash ```bash
sudo borgmatic --verbosity 1 --files sudo borgmatic create --verbosity 1 --files
``` ```
(No borgmatic `--files` flag? It's only present in newer versions of (No borgmatic `--files` flag? It's only present in newer versions of
borgmatic. So try leaving it out, or upgrade borgmatic!) borgmatic. So try leaving it out, or upgrade borgmatic!)
By default, this will also prune any old backups as per the configured Or, you can omit the `create` action to prune any old backups as per the
retention policy, compact segments to free up space (with Borg 1.2+), and configured retention policy, compact segments to free up space (with Borg
check backups for consistency problems due to things like file damage. 1.2+), create a backup, *and* check backups for consistency problems due to
things like file damage:
```bash
sudo borgmatic --verbosity 1 --files
```
The verbosity flag makes borgmatic show the steps it's performing. And the The verbosity flag makes borgmatic show the steps it's performing. And the
files flag lists each file that's new or changed since the last backup. files flag lists each file that's new or changed since the last backup.