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

documentation: btrbk.1: explain root privileges and snapshot/backup terminology

pull/208/merge
Axel Burri 2018-10-13 13:14:31 +02:00
parent 37def3dc7e
commit ad20b9a360
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/btrbk.1.asciidoc
View File

@ -35,7 +35,16 @@ btrfs specific capabilities to create atomic snapshots and transfer
them incrementally to a target btrfs filesystem. It is able to perform them incrementally to a target btrfs filesystem. It is able to perform
backups from one source to multiple destinations. backups from one source to multiple destinations.
Snapshots as well as backup subvolume names are created in form: For most operations, *btrbk* requires 'root privileges' to run
correctly. Alternatively, consider using "btrfs-progs-sudo" or
"btrfs-progs-btrbk" backends, both of which allows you to run btrbk as
a regular user. Refer to configuration option 'backend' in
btrbk.conf(5) for more details.
=== Snapshots and Backups
Snapshots as well as backup subvolumes are created in form:
<snapshot-name>.<timestamp>[_N] <snapshot-name>.<timestamp>[_N]
@ -48,6 +57,11 @@ minute of the creation time (local time of the host running btrbk). If
multiple snapshots/backups are created on the same date/time, N will multiple snapshots/backups are created on the same date/time, N will
be incremented on each snapshot, starting at 1. be incremented on each snapshot, starting at 1.
Note that 'snapshot' is a btrfs terminology for a ``read-only
subvolume'' (showing a parent-uuid, see btrfs-subvolume(8)); 'backup'
is a btrbk terminology for a ``read-only subvolume created with
send/receive'' (showing a received-uuid).
OPTIONS OPTIONS
------- -------