From ad20b9a36089231f8d340c51aac81c6329fccda5 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Sat, 13 Oct 2018 13:14:31 +0200 Subject: [PATCH] documentation: btrbk.1: explain root privileges and snapshot/backup terminology --- doc/btrbk.1.asciidoc | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/btrbk.1.asciidoc b/doc/btrbk.1.asciidoc index 60b0da9..732e232 100644 --- a/doc/btrbk.1.asciidoc +++ b/doc/btrbk.1.asciidoc @@ -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 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: .[_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 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 -------