documentation: btrbk.conf.5: optional volume section

pull/411/head
Axel Burri 2021-08-08 21:30:34 +02:00
parent 9a806d85ef
commit e6106c3cda
1 changed files with 17 additions and 23 deletions

View File

@ -48,22 +48,17 @@ inconvenience.
SECTIONS SECTIONS
-------- --------
*volume* <volume-directory>|<url>:: *volume* <volume-directory>|<url> (optional)::
Directory of a btrfs volume containing the source subvolume(s) to Absolute path pointing to a btrfs file system containing the
be backed up. '<volume-directory>' must be an absolute path and source subvolume(s) to be backed up. Usually the mount point of a
point to a btrfs volume (or subvolume). Usually the mount point of btrfs filesystem mounted with the 'subvolid=5' option.
a btrfs filesystem mounted with the 'subvolid=5' option.
*subvolume* <subvolume-name>:: *subvolume* <subvolume-name>::
Subvolume to be backed up, relative to the '<volume-directory>' Subvolume to be backed up, relative to the '<volume-directory>' of
specified in the 'volume' section. Multiple 'subvolume' sections the 'volume' section, or absolute if the 'volume' section is
are allowed within 'volume' sections. Accepts wildcard character omitted. Accepts wildcard character "*".
"*".
+ +
-- --
If set to ".", the subvolume at '<volume-directory>' is used as backup
source, and the snapshots will be created within the source subvolume
itself (see 'snapshot_dir' option below), which is not recommended.
Note that if this subvolume is btrfs root (id=5), it needs to have a Note that if this subvolume is btrfs root (id=5), it needs to have a
valid UUID, which is not the case for file systems created with valid UUID, which is not the case for file systems created with
btrfs-progs < 4.16. btrfs-progs < 4.16.
@ -133,8 +128,9 @@ Note that using ``long-iso'' has implications on the scheduling, see
*snapshot_dir* <directory>:: *snapshot_dir* <directory>::
Directory in which the btrfs snapshots are created, relative to Directory in which the btrfs snapshots are created, relative to
'<volume-directory>' of the 'volume' section. Note that btrbk does '<volume-directory>' of the 'volume' section, or absolute if the
not automatically create this directory, and the snapshot creation 'volume' section is omitted. Note that btrbk does not
automatically create this directory, and the snapshot creation
will fail if it is not present. will fail if it is not present.
*snapshot_name* <basename>:: *snapshot_name* <basename>::
@ -439,12 +435,11 @@ If you want to set this option for regular (non-root) user only, set
*incremental_resolve* mountpoint|directory:: *incremental_resolve* mountpoint|directory::
Specifies where to search for the best common parent for Specifies where to search for the best common parent for
incremental backups. If set to ``mountpoint'', use parents in the incremental backups. If set to ``mountpoint'', use parents in the
filesystem tree below mount points of source filesystem tree below the mount point of the snapshot and target
"<volume-directory>/<snapshot-dir>" and target directory. If set to ``directory'', use parents strictly below
"<target-directory>". If set to ``directory'', use parents snapshot/target directories. Set this to ``directory'' if you get
strictly below source/target directories. Set this to access problems (when not running btrbk as root). Defaults to
``directory'' if you get access problems (when not running btrbk ``mountpoint''.
as root). Defaults to ``mountpoint''.
*snapshot_qgroup_destroy* yes|no _*experimental*_:: {blank} *snapshot_qgroup_destroy* yes|no _*experimental*_:: {blank}
*target_qgroup_destroy* yes|no _*experimental*_:: {blank} *target_qgroup_destroy* yes|no _*experimental*_:: {blank}
@ -544,9 +539,8 @@ TARGET TYPES
*send-receive*:: *send-receive*::
Backup to a btrfs filesystem, using "btrfs send/receive". This is Backup to a btrfs filesystem, using "btrfs send/receive". This is
the recommended (standard) target type. The '<target-directory>' the recommended (standard) target type. The '<target-directory>'
must be an absolute path and point to a btrfs volume (or must be an absolute path and point to a subvolume or directory
subvolume), or to a directory within a subvolume. See within a btrfs file system. See btrfs-send(8), btrfs-receive(8).
btrfs-send(8), btrfs-receive(8).
*raw* _*experimental*_:: *raw* _*experimental*_::
Backup to a raw (filesystem independent) file from the output of Backup to a raw (filesystem independent) file from the output of