Browse Source

In documentation, be more explicit about default actions (#554).

Dan Helfman 3 years ago
parent
commit
1fc028ffae
1 changed files with 12 additions and 9 deletions
  1. 12 9
      docs/how-to/set-up-backups.md

+ 12 - 9
docs/how-to/set-up-backups.md

@@ -232,15 +232,6 @@ 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!)
 
-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.
 Eyeball the list and see if it matches your expectations based on the
@@ -250,6 +241,18 @@ If you'd like to specify an alternate configuration file path, use the
 `--config` flag. See `borgmatic --help` for more information.
 
 
+## Default actions
+
+If you omit `create` and other actions, borgmatic runs through a set of
+default actions: `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. For instance:
+
+```bash
+sudo borgmatic --verbosity 1 --files
+```
+
 ## Autopilot
 
 Running backups manually is good for validating your configuration, but I'm