Document the possible units of times for a configured check frequency.
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Dan Helfman 2023-11-08 17:53:59 -08:00
parent 26bb54a9dd
commit eef69e23ee
1 changed files with 10 additions and 1 deletions

View File

@ -117,7 +117,16 @@ this option in the `consistency:` section of your configuration.
This tells borgmatic to run the `repository` consistency check at most once
every two weeks for a given repository and the `archives` check at most once a
month. The `frequency` value is a number followed by a unit of time, e.g. "3
days", "1 week", "2 months", etc.
days", "1 week", "2 months", etc. The set of possible time units is as
follows (singular or plural):
* `second`
* `minute`
* `hour`
* `day`
* `week` (7 days)
* `month` (30 days)
* `year` (365 days)
The `frequency` defaults to `always` for a check configured without a
`frequency`, which means run this check every time checks run. But if you omit