Skip to content

Commit

Permalink
update prune documentation for new --keep-within intervals
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Jan 10, 2025
1 parent b9498ca commit 45b8e62
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/usage/prune.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,11 @@ from different machines) in one shared repository, use one prune call per
series.

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
where char is "y", "m", "w", "d", "H", "M", or "S" and represents years, months,
weeks, days, hours, minutes or seconds. 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.
"1m" is taken to mean "31d" and "1y" represents "365d". 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,
Expand All @@ -173,4 +174,4 @@ backup archive in the same second).

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 repo-list`` description for more details about the format string).
the ``borg repo-list`` description for more details about the format string).

0 comments on commit 45b8e62

Please sign in to comment.