documentation: add documentation for {snapshot,target}_preserve_yearly

pull/73/head
Axel Burri 2016-02-29 20:12:55 +01:00
parent 4aa4be3942
commit b90cc132c1
1 changed files with 10 additions and 1 deletions

View File

@ -1,4 +1,4 @@
.TH "btrbk.conf" "5" "2016-02-02" "btrbk v0.22.2" ""
.TH "btrbk.conf" "5" "2016-02-29" "btrbk v0.23.0-dev" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@ -145,12 +145,21 @@ preserved. Every last weekly backup in a month is considered a
monthly backup. Defaults to \[lq]all\[rq].
.RE
.PP
\fBtarget_preserve_yearly\fR all|<number>
.RS 4
Defines for how many years back yearly backups should be
preserved. Every last monthly backup in a year is considered a yearly
backup. Defaults to \[lq]0\[rq].
.RE
.PP
\fBsnapshot_preserve_daily\fR
.PD 0
.PP
\fBsnapshot_preserve_weekly\fR
.PP
\fBsnapshot_preserve_monthly\fR
.PP
\fBsnapshot_preserve_yearly\fR
.RS 4
Defines retention policy for the snapshots, with same semantics as the
\fItarget_preserve_*\fR options.