summaryrefslogtreecommitdiff
path: root/obnam.1.in
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2012-10-20 22:48:32 +0100
committerLars Wirzenius <liw@liw.fi>2012-10-20 22:48:32 +0100
commit4a9f801b7e86e6236bcfa4376a8ff320ee787e2e (patch)
tree2bf65c19de350521ae01145896a1a0c6047b98a4 /obnam.1.in
parent67de542c0384576a5591bb93c1193e61dfd0fdea (diff)
downloadobnam-4a9f801b7e86e6236bcfa4376a8ff320ee787e2e.tar.gz
Improve manpage on forget's keep policies
Reported-By: Neal Becker
Diffstat (limited to 'obnam.1.in')
-rw-r--r--obnam.1.in18
1 files changed, 17 insertions, 1 deletions
diff --git a/obnam.1.in b/obnam.1.in
index 63084d14..65fdd8a4 100644
--- a/obnam.1.in
+++ b/obnam.1.in
@@ -288,7 +288,8 @@ A policy of
.I 30d
means to keep the latest backup for each day when a backup was made,
and keep the last 30 such backups.
-Any backups in between will be removed,
+Any backup matched by any policy rule is kept,
+and any backups in between will be removed,
as will any backups older than the oldest kept backup.
.PP
As an example, assume backups are taken every hour, on the hour:
@@ -332,6 +333,21 @@ the effect is that the 23:00 o'clock backup for each day is
saved for a month,
and the 23:00 backup on Sundays is saved for a year.
.PP
+If, instead, you use a policy of
+.IR 72h,30d,52w ,
+.B obnam
+would keep the last 72 hourly backups,
+and the last backup of each calendar day for 30 days,
+and the last backup of each calendar week for 52 weeks.
+If the backup frequency was once per day,
+.B obnam
+would keep the backup of each calendar hour for which a backup was made,
+for 72 such backups.
+In other words, it would effectively keep the the last 72 daily backups.
+.PP
+Sound confusing?
+Just wonder how confused the developer was when writing the code.
+.PP
If no policy is given,
.B forget
will keep everything.