From 2e0b2a308f656d93301d0d196a802289051f0c96 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Wed, 29 Jun 2022 09:20:13 -0700 Subject: [PATCH] Clarify --files flag action in documentation (#554). --- docs/how-to/set-up-backups.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index 378381c..8d0e34b 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -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: ```bash -sudo borgmatic --verbosity 1 --files +sudo borgmatic create --verbosity 1 --files ``` (No borgmatic `--files` flag? It's only present in newer versions of borgmatic. So try leaving it out, or upgrade borgmatic!) -By default, this will also prune any old backups as per the configured -retention policy, compact segments to free up space (with Borg 1.2+), and -check backups for consistency problems due to things like file damage. +Or, you can omit the `create` action to prune any old backups as per the +configured retention policy, compact segments to free up space (with Borg +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 files flag lists each file that's new or changed since the last backup.