From d6f2988591408eec0e6c227ea07791927edcc55b Mon Sep 17 00:00:00 2001 From: Florian Pritz Date: Sun, 2 Apr 2017 11:41:27 +0200 Subject: Start documenting the main class Signed-off-by: Florian Pritz --- lib/App/BorgRestore.pm | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/App/BorgRestore.pm b/lib/App/BorgRestore.pm index 6d3d5c7..a424dff 100644 --- a/lib/App/BorgRestore.pm +++ b/lib/App/BorgRestore.pm @@ -35,7 +35,20 @@ App::BorgRestore - Restore paths from borg backups =head1 DESCRIPTION -App::BorgRestore is ... +App::BorgRestore is a restoration helper for borg. + +It maintains a cache of borg backup contents (path and latest modification +time) and allows to quickly look up backups that contain a path. It further +supports restoring a path from an archive. The archive to be used can also be +automatically determined based on the age of the path. + +The cache has to be updated regularly, ideally after creating or removing +backups. + +B is a wrapper around this class that allows for simple CLI +usage. + +This package uses L for logging. =head1 LICENSE -- cgit v1.2.3-24-g4f1b