From eef69e23ee9c915c36ae386080c1f3efd18596a6 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Wed, 8 Nov 2023 17:53:59 -0800 Subject: [PATCH] Document the possible units of times for a configured check frequency. --- docs/how-to/deal-with-very-large-backups.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index c609ba1..69be91b 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -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