From 14b5edcf6858d67c6f0db94ee6d3eb7bda4e6f6c Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Wed, 17 Apr 2019 16:55:59 +0200 Subject: [PATCH] documentation: btrbk.1: update filter statements section --- doc/btrbk.1.asciidoc | 47 +++++++++++++++++++++++++++++--------------- 1 file changed, 31 insertions(+), 16 deletions(-) diff --git a/doc/btrbk.1.asciidoc b/doc/btrbk.1.asciidoc index 0805cee..fff3972 100644 --- a/doc/btrbk.1.asciidoc +++ b/doc/btrbk.1.asciidoc @@ -362,27 +362,42 @@ FILTER STATEMENTS Filter arguments are accepted in form: :: - Matches the 'group' configuration option of a 'volume', - 'subvolume' or 'target' section (including all underlying - sections). + Matches the 'group' configuration option of 'volume', 'subvolume' + or 'target' sections. -[hostname:]:: - Matches all subvolumes and targets of a 'volume' configuration - section. +[:]:: + Matches the 'hostname' portion from '' of 'volume' or + 'target' sections. -[hostname:]/:: - Matches the specified subvolume and all targets of a 'subvolume' - configuration section. +|:: + Matches 'volume', 'subvolume' or 'target' sections by either + relative or absolute path (if starting with "/" or "ssh://" or + ":/"), accepting wildcard character "*". Relative paths + are matched against the end of the pathname. Either: ++ +-- +:: + Matches 'volume' sections. -[hostname:]:: - Matches all targets of a 'target' configuration section. +/:: + Matches 'subvolume' sections. -[hostname:]/:: - Matches a single target of a 'target' section within a 'subvolume' - section with given . +//:: + Matches 'subvolume' sections defining snapshots with the + configured 'snapshot_dir' and 'snapshot_name'. -For convenience, [hostname:] can be specified as either "hostname:" or -"ssh://hostname[:port]/". +:: + Matches 'target' sections. + +/:: + Matches 'target' sections within 'subvolume' sections defining + snapshots with the configured 'snapshot_name'. + +Accepted formats for '' are: + + ssh://[:]/ + : +-- Note that for *run* and *snapshot* commands, a filter matching a 'target' configuration section also enables snapshot creation of the