diff --git a/docs/reference/command-line.md b/docs/reference/command-line.md index 9cfdd7ee..08ccd601 100644 --- a/docs/reference/command-line.md +++ b/docs/reference/command-line.md @@ -7,11 +7,17 @@ eleventyNavigation: --- ## borgmatic options -Here are all of the available borgmatic command-line options, including the -separate options for each action sub-command. Note that most of the -flags listed here do not have equivalents in borgmatic's [configuration +Here are all of the available borgmatic command-line flags for the most recent +version of borgmatic, including the separate flags for each action +(sub-command). Most of the flags listed here do not have equivalents in +borgmatic's [configuration file](https://torsion.org/borgmatic/docs/reference/configuration/). +If you're using an older version of borgmatic, some of these flags may not be +present in that version, and you should instead use `borgmatic --help` or +`borgmatic [action name] --help` (where `[action name]` is the name of an +action like `list`, `create`, etc.). + ``` {% include borgmatic/command-line.txt %} ``` diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 316e58f0..d82eb8ed 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -7,11 +7,17 @@ eleventyNavigation: --- ## Configuration file -Here is a full sample borgmatic configuration file including all available options: +Below is a sample borgmatic configuration file including all available options +for the most recent version of borgmatic. This file is also [available for +download](https://torsion.org/borgmatic/docs/reference/config.yaml). + +If you're an older version of borgmatic, some of these options may not work, +and you should instead [generate a sample configuration file specific to your +borgmatic +version](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#configuration). ```yaml {% include borgmatic/config.yaml %} ``` Note that you can also [download this configuration -file](https://torsion.org/borgmatic/docs/reference/config.yaml) for use locally.