diff options
| author | Florian Pritz <bluewind@xinu.at> | 2017-04-02 11:41:27 +0200 |
|---|---|---|
| committer | Florian Pritz <bluewind@xinu.at> | 2017-04-02 13:42:15 +0200 |
| commit | d6f2988591408eec0e6c227ea07791927edcc55b (patch) | |
| tree | 620884eec1da1795448d0f063c023fc6db96e741 | |
| parent | 97e89588a0cc383e357e7d72ae529bc7217d9847 (diff) | |
| download | App-BorgRestore-d6f2988591408eec0e6c227ea07791927edcc55b.tar.gz App-BorgRestore-d6f2988591408eec0e6c227ea07791927edcc55b.tar.xz | |
Start documenting the main class
Signed-off-by: Florian Pritz <bluewind@xinu.at>
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | lib/App/BorgRestore.pm | 15 |
2 files changed, 28 insertions, 2 deletions
@@ -8,7 +8,20 @@ App::BorgRestore - Restore paths from borg backups # 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. + +**borg-restore.pl** is a wrapper around this class that allows for simple CLI +usage. + +This package uses [Log::Any](https://metacpan.org/pod/Log::Any) for logging. # LICENSE 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<borg-restore.pl> is a wrapper around this class that allows for simple CLI +usage. + +This package uses L<Log::Any> for logging. =head1 LICENSE |