Skip to content

Commit

Permalink
Merge pull request #7688 from TimWolla/patch-1
Browse files Browse the repository at this point in the history
Improve the documentation for `--keep-within`
  • Loading branch information
ThomasWaldmann committed Jul 1, 2023
2 parents f43fcd3 + a6f452a commit c539b40
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/usage/prune.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,6 @@ from different machines) in one shared repository, use one prune call per
data set that matches only the respective archives using the --match-archives
(-a) option.

The ``--keep-within`` option takes an argument of the form "<int><char>",
where char is "H", "d", "w", "m", "y". For example, ``--keep-within 2d`` means
to keep all archives that were created within the past 48 hours.
"1m" is taken to mean "31d". The archives kept with this option do not
count towards the totals specified by any other options.

A good procedure is to thin out more and more the older your backups get.
As an example, ``--keep-daily 7`` means to keep the latest backup on each day,
up to 7 most recent days with backups (days without backups do not count).
Expand All @@ -158,6 +152,13 @@ minutely, hourly, daily, weekly, monthly, or yearly rules was not otherwise able
meet its retention target. This enables the first chronological archive to continue
aging until it is replaced by a newer archive that meets the retention criteria.

The ``--keep-within`` option takes an argument of the form "<int><char>",
where char is "H", "d", "w", "m", "y". For example, ``--keep-within 2d`` means
to keep all archives that were created within the past 48 hours.
"1m" is taken to mean "31d". This option is applied before the secondly option
and like the other options any archives kept by this option do not count towards
the later rules.

The ``--keep-last N`` option is doing the same as ``--keep-secondly N`` (and it will
keep the last N archives under the assumption that you do not create more than one
backup archive in the same second).
Expand All @@ -169,4 +170,4 @@ Please note that the "All archives" stats refer to the state after pruning.

You can influence how the ``--list`` output is formatted by using the ``--short``
option (less wide output) or by giving a custom format using ``--format`` (see
the ``borg rlist`` description for more details about the format string).
the ``borg rlist`` description for more details about the format string).

0 comments on commit c539b40

Please sign in to comment.