documentation: add documentation for target propagation and target directories

pull/88/head
Axel Burri 2016-03-31 13:53:00 +02:00
parent 79caba4267
commit 90a3537433
2 changed files with 11 additions and 4 deletions

View File

@ -1,6 +1,9 @@
btrbk-current btrbk-current
* Allow wildcards in subvolume section (close: #71). * Allow wildcards in subvolume section (close: #71).
* Allow regular directories for send-receive targets.
* Propagate targets defined in "volume" or "root" context to all
"subvolume" sections.
* Added "{snapshot,target}_preserve NNd NNw NNm NNy" shortcut. * Added "{snapshot,target}_preserve NNd NNw NNm NNy" shortcut.
* Added yearly retention policies (close: #69). * Added yearly retention policies (close: #69).
* Added configuration option "rate_limit" (close: #72). * Added configuration option "rate_limit" (close: #72).

View File

@ -1,4 +1,4 @@
.TH "btrbk.conf" "5" "2016-03-23" "btrbk v0.23.0-dev" "" .TH "btrbk.conf" "5" "2016-03-31" "btrbk v0.23.0-dev" ""
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
@ -41,7 +41,11 @@ sections are allowed within \fIvolume\fR sections.
Target type and directory where the backup subvolumes are to be Target type and directory where the backup subvolumes are to be
created. See the TARGET TYPES section for supported created. See the TARGET TYPES section for supported
\fI<type>\fR. Multiple \fItarget\fR sections are allowed within \fI<type>\fR. Multiple \fItarget\fR sections are allowed within
\fIsubvolume\fR sections. \fIsubvolume\fR sections. A \fItarget\fR section defined in the global
context or in a \fIvolume\fR section is propagated (mulitplied) to all
underlying \fIsubvolume\fR sections, unless a target with the same
declaration already exists (hint: run "btrbk config print" to see the
resulting configuration).
.RE .RE
.PP .PP
For the \fIvolume\fR and \fItarget\fR sections, you can specify a For the \fIvolume\fR and \fItarget\fR sections, you can specify a
@ -255,8 +259,8 @@ treated as comments.
.RS 4 .RS 4
Backup to a btrfs filesystem, using "btrfs send/receive". This is the Backup to a btrfs filesystem, using "btrfs send/receive". This is the
recommended (standard) target type. The \fI<target-directory>\fR must recommended (standard) target type. The \fI<target-directory>\fR must
be an absolute path and point to a btrfs volume (or subvolume). See be an absolute path and point to a btrfs volume (or subvolume), or to
btrfs-send(8), btrfs-receive(8). a directory within a subvolume. See btrfs-send(8), btrfs-receive(8).
.RE .RE
.PP .PP
\fBraw\fR \fI*experimental*\fR \fBraw\fR \fI*experimental*\fR