From fdba94f8c75e798aaaed02430118db5f6ca63c27 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Tue, 10 Oct 2017 16:37:16 +0200 Subject: [PATCH] documentation: btrbk.1.asciidoc: add action command / result matrix --- doc/btrbk.1.asciidoc | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/doc/btrbk.1.asciidoc b/doc/btrbk.1.asciidoc index 39deabd..2f87086 100644 --- a/doc/btrbk.1.asciidoc +++ b/doc/btrbk.1.asciidoc @@ -234,6 +234,49 @@ unsure. operation is ongoing, and are identified by the "received_uuid" flag not being set on a target (backup) subvolume. +The following table gives a quick overview of the action commands and +resulting snapshot creation (S+), backup creation (B+), snapshot +deletion (S-), and backup deletion (B-): + +ifdef::backend-docbook[] +.... +Command Option S+ B+ S- B- +-------------------------------------------- +run x x x x +run --preserve x x +run --preserve-snapshots x x x +run --preserve-backups x x x +snapshot x x +snapshot --preserve x +resume x x x +resume --preserve x +resume --preserve-snapshots x x +resume --preserve-backups x x +prune x x +prune --preserve-snapshots x +prune --preserve-backups x +.... +endif::backend-docbook[] +ifndef::backend-docbook[] +[cols="2*