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

documentation: btrbk.conf.5: replaced double quotes "\(lq", "\(rq" with "\[lq]", "\[rq]", which is identical in groff but produces correct output in the FileWiki::Plugin::Man module

pull/30/head
Axel Burri 2015-05-20 13:50:18 +02:00
parent 8217da5f03
commit 4db0aa0128
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/btrbk.conf.5
View File

@ -32,7 +32,7 @@ specified in the \fIvolume\fR section.
Target type and directory where the backup subvolumes are to be Target type and directory where the backup subvolumes are to be
created. \fI<volume-directory>\fR must be an absolute path and point created. \fI<volume-directory>\fR must be an absolute path and point
to a btrfs volume (or subvolume). Currently the the only valid to a btrfs volume (or subvolume). Currently the the only valid
\fI<type>\fR is \(lqsend\-receive\(rq. \fI<type>\fR is \[lq]send\-receive\[rq].
.PP .PP
For the \fIvolume\fR and \fItarget\fR sections, you can also specify a For the \fIvolume\fR and \fItarget\fR sections, you can also specify a
ssh-url instead of a local directory. The syntax for \fI<url>\fR is: ssh-url instead of a local directory. The syntax for \fI<url>\fR is:
@ -63,30 +63,30 @@ reached). Use in conjunction with the \fIresume_missing\fR option to
make sure that the backups are created as soon as the target subvolume make sure that the backups are created as soon as the target subvolume
is reachable again. Useful for laptop filesystems in order to make is reachable again. Useful for laptop filesystems in order to make
sure the snapshots are created even if you are on the road. Defaults sure the snapshots are created even if you are on the road. Defaults
to \(lqno\(rq. to \[lq]no\[rq].
.TP .TP
\fBincremental\fR yes|no|strict \fBincremental\fR yes|no|strict
Perform incremental backups. Defaults to \(lqyes\(rq. If set to Perform incremental backups. Defaults to \[lq]yes\[rq]. If set to
\(lqstrict\(rq, non-incremental (initial) backups are never created. \[lq]strict\[rq], non-incremental (initial) backups are never created.
.TP .TP
\fBresume_missing\fR yes|no \fBresume_missing\fR yes|no
If set, the backups in the target directory are compared to the source If set, the backups in the target directory are compared to the source
snapshots, and missing backups are created if needed (complying to the snapshots, and missing backups are created if needed (complying to the
target preserve matrix). Defaults to \(lqyes\(rq. target preserve matrix). Defaults to \[lq]yes\[rq].
.TP .TP
\fBtarget_preserve_daily\fR all|<number> \fBtarget_preserve_daily\fR all|<number>
How many days of backups should be preserved. Defaults to \(lqall\(rq. How many days of backups should be preserved. Defaults to \[lq]all\[rq].
.TP .TP
\fBtarget_preserve_weekly\fR all|<number> \fBtarget_preserve_weekly\fR all|<number>
Defines for how many weeks back weekly backups should be Defines for how many weeks back weekly backups should be
preserved. Every backup created at \fIpreserve_day_of_week\fR (or preserved. Every backup created at \fIpreserve_day_of_week\fR (or
the next backup in this week if none was made on the exact day) is the next backup in this week if none was made on the exact day) is
considered as a weekly backup. Defaults to \(lq0\(rq. considered as a weekly backup. Defaults to \[lq]0\[rq].
.TP .TP
\fBtarget_preserve_monthly\fR all|<number> \fBtarget_preserve_monthly\fR all|<number>
Defines for how many months back monthly backups should be Defines for how many months back monthly backups should be
preserved. Every last weekly backup in a month is considered a preserved. Every last weekly backup in a month is considered a
monthly backup. Defaults to \(lqall\(rq. monthly backup. Defaults to \[lq]all\[rq].
.TP .TP
\fBsnapshot_preserve_daily\fR \fBsnapshot_preserve_daily\fR
.PD 0 .PD 0
@ -100,7 +100,7 @@ Define retention policy for the snapshots, with same semantics as the
.TP .TP
\fBpreserve_day_of_week\fR monday|tuesday|...|sunday \fBpreserve_day_of_week\fR monday|tuesday|...|sunday
Defines on what day a backup/snapshot is considered as a weekly Defines on what day a backup/snapshot is considered as a weekly
backup. Defaults to \(lqsunday\(rq. backup. Defaults to \[lq]sunday\[rq].
.TP .TP
\fBssh_identity\fR <file> \fBssh_identity\fR <file>
Absolute path to a ssh identity file (private key). Note that if the Absolute path to a ssh identity file (private key). Note that if the
@ -108,13 +108,13 @@ private key is password protected, btrbk will prompt for user input,
which is usually not desired. which is usually not desired.
.TP .TP
\fBssh_user\fR <username> \fBssh_user\fR <username>
Remote username for ssh. Defaults to \(lqroot\(rq. Note that you will Remote username for ssh. Defaults to \[lq]root\[rq]. Note that you will
have to make sure that the remote user is able to run /sbin/btrfs have to make sure that the remote user is able to run /sbin/btrfs
(which needs root privileges). (which needs root privileges).
.TP .TP
\fBbtrfs_commit_delete\fR after|each|no \fBbtrfs_commit_delete\fR after|each|no
If set, make sure the deletion of snapshot and backup subvolumes are If set, make sure the deletion of snapshot and backup subvolumes are
committed to disk when btrbk terminates. Defaults to \(lqno\(rq. committed to disk when btrbk terminates. Defaults to \[lq]no\[rq].
.TP .TP
\fBbtrfs_progs_compat\fR yes|no \fI*experimental*\fR \fBbtrfs_progs_compat\fR yes|no \fI*experimental*\fR
Enable compatibility mode for btrfs-progs < 3.17 (\fIbtrfs Enable compatibility mode for btrfs-progs < 3.17 (\fIbtrfs