From: Ralph Ronnquist <rrq@rrq.au>
Date: Wed, 22 Jan 2025 01:50:16 +0000 (+1100)
Subject: Expanded documentation for the "source" format, including exclusions.
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=refs%2Fheads%2Fupstream;p=rrq%2Ftimeliner.git

Expanded documentation for the "source" format, including exclusions.
---

diff --git a/timeliner.8.adoc b/timeliner.8.adoc
index b9e349d..7fc8af5 100644
--- a/timeliner.8.adoc
+++ b/timeliner.8.adoc
@@ -38,6 +38,12 @@ _host:directory_.
 In both cases, the timeline directory must reside in a filesystem
 cabale of hard links.
 
+The source specification is a directory to be backed up optionally
+followed by colon separated, one or more subtree glob paths to
+exclude. As an example, "/home:*/.cache:guest/Pictures" would declare
+source directory tree "/home" but excluding all user's ".cache" sub
+trees and also excluding the "guest" user's "Pictures" sub tree.
+
 == timeliner-backup
 
 *timeliner-backup* is a companion script that normally is set up as a