diff --git a/doc/btrbk.conf.5.asciidoc b/doc/btrbk.conf.5.asciidoc index e84eb5a..6088c9a 100644 --- a/doc/btrbk.conf.5.asciidoc +++ b/doc/btrbk.conf.5.asciidoc @@ -487,21 +487,24 @@ sources for all (!) known candidates on the filesystem. RETENTION POLICY ---------------- -btrbk uses separate retention policies for snapshots and backups, -which are defined by the 'snapshot_preserve_min', 'snapshot_preserve', -'target_preserve_min', 'target_preserve', 'preserve_day_of_week' and -'preserve_hour_of_day' configuration options. +Retention policies are defined individually for snapshots, backups and +archives (summarized as "backups" in the following text), using a +combination of: -Within this section, any statement about "backups" is always valid for -backups as well as snapshots, referring to 'target_preserve' or -'snapshot_preserve' respectively. +**_preserve_min* all|latest|no|{h,d,w,m,y}:: + Amount of time (duration) in which all backups are preserved. + +**_preserve* no|:: + Schedule (single points in time) for which individual backups are + preserved. + +Note that if "preserve_min" is set to ``all'' (the default), any +setting of "preserve" obviously has no effect. The format for '' is: [h] [d] [w] [m] [y] -With the following semantics: - *hourly*:: Defines how many hours back hourly backups should be preserved. The first backup of an hour is considered an hourly