TrueCloudLab/restic
16
0
Fork 3
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1615 from rawtaz/fix-forget-doc

Browse source 
Fix #1519 and formatting in `forget` doc
This commit is contained in:
Alexander Neumann 2018-02-14 22:11:10 +01:00
commit fde674d214
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/060_forget.rst
View file

@ -145,19 +145,20 @@ tags use ``--group-by paths,tags``. The policy is then applied to each group of
snapshots separately. This is a safety feature. snapshots separately. This is a safety feature.
The ``forget`` command accepts the following parameters: The ``forget`` command accepts the following parameters:
- ``--keep-last n`` never delete the ``n`` last (most recent) snapshots - ``--keep-last n`` never delete the ``n`` last (most recent) snapshots
- ``--keep-hourly n`` for the last ``n`` hours in which a snapshot was - ``--keep-hourly n`` for the last ``n`` hours in which a snapshot was
made, keep only the last snapshot for each hour. made, keep only the last snapshot for each hour.
- ``--keep-daily n`` for the last ``n`` days which have one or more - ``--keep-daily n`` for the last ``n`` days which have one or more
snapshots, only keep the last one for that day. snapshots, only keep the last one for that day.
- ``--keep-weekly n`` for the last ``n`` weeks which have one or more - ``--keep-weekly n`` for the last ``n`` weeks which have one or more
snapshots, only keep the last one for that week. snapshots, only keep the last one for that week.
- ``--keep-monthly n`` for the last ``n`` months which have one or more - ``--keep-monthly n`` for the last ``n`` months which have one or more
snapshots, only keep the last one for that month. snapshots, only keep the last one for that month.
- ``--keep-yearly n`` for the last ``n`` years which have one or more - ``--keep-yearly n`` for the last ``n`` years which have one or more
snapshots, only keep the last one for that year. snapshots, only keep the last one for that year.
- ``--keep-tag`` keep all snapshots which have all tags specified by - ``--keep-tag`` keep all snapshots which have all tags specified by
this option (can be specified multiple times). this option (can be specified multiple times).
Additionally, you can restrict removing snapshots to those which have a Additionally, you can restrict removing snapshots to those which have a
particular hostname with the ``--hostname`` parameter, or tags with the particular hostname with the ``--hostname`` parameter, or tags with the
@ -187,7 +188,13 @@ All the ``--keep-*`` options above only count
hours/days/weeks/months/years which have a snapshot, so those without a hours/days/weeks/months/years which have a snapshot, so those without a
snapshot are ignored. snapshot are ignored.
All snapshots are evaluated counted against all matching keep-* counts. A For safety reasons, restic refuses to act on an "empty" policy. For example,
if one were to specify ``--keep-last 0`` to forget *all* snapshots in the
repository, restic will respond that no snapshots will be removed. To delete
all snapshots, use ``--keep-last 1`` and then finally remove the last
snapshot ID manually (by passing the ID to ``forget``).
All snapshots are evaluated against all matching ``--keep-*`` counts. A
single snapshot on 2017-09-30 (Sun) will count as a daily, weekly and monthly. single snapshot on 2017-09-30 (Sun) will count as a daily, weekly and monthly.
Let's explain this with an example: Suppose you have only made a backup Let's explain this with an example: Suppose you have only made a backup