ambiser
/
btrbk
mirror of https://github.com/digint/btrbk
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation: btrbk.1: update sections containing infos about retention policy; fix documentation of -p option; cosmetics

pull/88/head
Axel Burri 2016-04-11 20:47:49 +02:00
parent 326edfcc29
commit 1e91f179d4
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/btrbk.1
View File

@ -1,4 +1,4 @@
.TH "btrbk" "1" "2016-04-09" "btrbk v0.23.0-dev" "" .TH "btrbk" "1" "2016-04-11" "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)
@ -17,8 +17,8 @@ btrbk \- backup tool for btrfs volumes
.SH DESCRIPTION .SH DESCRIPTION
\fBbtrbk\fR is a backup tool for btrfs subvolumes, taking advantage of \fBbtrbk\fR is a backup tool for btrfs subvolumes, taking advantage of
btrfs specific capabilities to create atomic snapshots and transfer btrfs specific capabilities to create atomic snapshots and transfer
them incrementally to target volumes. It is able to perform backups them incrementally to a target btrfs filesystem. It is able to perform
from one source to multiple destinations. backups from one source to multiple destinations.
.PP .PP
Snapshots as well as backup subvolume names are created in form: Snapshots as well as backup subvolume names are created in form:
.PP .PP
@ -33,7 +33,7 @@ unless the configuration option \fIsnapshot_name\fR is set. The
year, "MM" is the month, "DD" is the day, "hh" is the hour and "mm" is year, "MM" is the month, "DD" is the day, "hh" is the hour and "mm" is
the minute of the creation time (local time of the host running the minute of the creation time (local time of the host running
btrbk). If multiple snapshots/backups are created on the same btrbk). If multiple snapshots/backups are created on the same
date/time, N will be incremented on each backup, starting at 1. date/time, N will be incremented on each snapshot, starting at 1.
.SH OPTIONS .SH OPTIONS
.PP .PP
\-h, \-\-help \-h, \-\-help
@ -61,8 +61,8 @@ Read the configuration from <file>.
.PP .PP
\-p, \-\-preserve \-p, \-\-preserve
.RS 4 .RS 4
Preserve all backups. Skips deletion of old backups, even if specified Preserve all snapshots and backups. Skips deletion of any snapshots
in the configuration file. and backups, even if specified in the configuration file.
.RE .RE
.PP .PP
\-r, \-\-resume-only \-r, \-\-resume-only
@ -118,10 +118,10 @@ between different output formats.
.B run .B run
[filter...] [filter...]
.RS 4 .RS 4
Perform backup operations as specified in the configuration file. If Perform snapshot and backup operations as specified in the
the optional [filter...] arguments are present, backups are only configuration file. If the optional [filter...] arguments are present,
performed for the subvolumes/targets matching a \fIFILTER STATEMENT\fR snapshots and backups are only performed for the subvolumes/targets
(see below). matching a \fIFILTER STATEMENT\fR (see below).
.PP .PP
First, btrbk reads information from the source and target btrfs First, btrbk reads information from the source and target btrfs
filesystems in order to perform sanity checks and identify filesystems in order to perform sanity checks and identify
@ -133,18 +133,19 @@ subvolumes specified in the configuration file.
Then, for each specified target, btrbk creates the backups as follows: Then, for each specified target, btrbk creates the backups as follows:
If the \fIresume_missing\fR option is set (the default), btrbk If the \fIresume_missing\fR option is set (the default), btrbk
transfers all missing snapshots needed to satisfy the configured transfers all missing snapshots needed to satisfy the configured
\fItarget_preserve_{daily,weekly,monthly}\fR retention policy, always \fItarget_preserve\fR retention policy, incrementally from the latest
incrementally from the latest common parent subvolume found. If no common parent subvolume found. If no common parent subvolume is found
common parent subvolume is found, a full backup is created for the (or if the \fIincremental\fR option is set to \[lq]no\[rq]), a full
first transfer. Note that the latest snapshot (the one created in the (non-incremental) backup is created. Note that the latest snapshot
first step) is always transferred, regardless of the retention policy. (the one created in the first step) is always transferred, regardless
.PP
As a last step, unless the -p (preserve backups) option is set,
snapshots and backup subvolumes that are not preserved by their
configured retention policy will be deleted. Note that the latest
snapshot as well as the latest backup is always preserved, regardless
of the retention policy. of the retention policy.
.PP .PP
As a last step, unless the \-p (\-\-preserve) option is set, snapshots
and backup subvolumes that are not preserved by their configured
retention policy will be deleted. Note that the latest snapshot as
well as the latest backup is always preserved, regardless of the
retention policy.
.PP
Use the \fI\-\-format\fR command line option to switch between Use the \fI\-\-format\fR command line option to switch between
different output formats. different output formats.
.RE .RE