Add note about uncommenting section names.

This commit is contained in:
Dan Helfman 2019-03-04 15:15:49 -08:00
parent 4272c6b077
commit 5a5b6491ac

View file

@ -45,9 +45,14 @@ not in your system `PATH`. Try looking in `/usr/local/bin/`.
This generates a sample configuration file at /etc/borgmatic/config.yaml (by This generates a sample configuration file at /etc/borgmatic/config.yaml (by
default). You should edit the file to suit your needs, as the values are default). You should edit the file to suit your needs, as the values are
representative. All fields are optional except where indicated, so feel free representative. All options are optional except where indicated, so feel free
to ignore anything you don't need. to ignore anything you don't need.
Note that the configuration file is organized into distinct sections, each
with a section name like `location:` or `storage:`. So take care that if you
uncomment a particular option, also uncomment its containing section name, or
else borgmatic won't recognize the option.
You can also get the same sample configuration file from the [configuration You can also get the same sample configuration file from the [configuration
reference](../../docs/reference/configuration.md), the authoritative set of reference](../../docs/reference/configuration.md), the authoritative set of
all configuration options. This is handy if borgmatic has added new options all configuration options. This is handy if borgmatic has added new options
@ -71,6 +76,9 @@ FAQ](http://borgbackup.readthedocs.io/en/stable/faq.html#how-can-i-specify-the-e
for more info. for more info.
###
## Initialization ## Initialization
Before you can create backups with borgmatic, you first need to initialize a Before you can create backups with borgmatic, you first need to initialize a