summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2016-08-15 16:18:18 +0200
committerFlorian Pritz <bluewind@xinu.at>2016-08-15 16:18:18 +0200
commit84da62727535446d3da2b61229127df28a304138 (patch)
treeac1a4fb63d8d4db045e470639b83c316c48f8412
parent325b568ff89d540cfecc8b22b7e5735a90b7451f (diff)
downloadbin-84da62727535446d3da2b61229127df28a304138.tar.gz
bin-84da62727535446d3da2b61229127df28a304138.tar.xz
borg-restore.pl: Improve documentation
Signed-off-by: Florian Pritz <bluewind@xinu.at>
-rwxr-xr-xborg-restore.pl18
1 files changed, 11 insertions, 7 deletions
diff --git a/borg-restore.pl b/borg-restore.pl
index 5f027a3..05e4edc 100755
--- a/borg-restore.pl
+++ b/borg-restore.pl
@@ -8,15 +8,19 @@ borg-restore.pl - Restore paths from borg backups
=head1 DESCRIPTION
-Script that helps to restore files from borg backups.
+borg-restore.pl helps to restore files from borg backups.
-Takes one path, looks for its backups, shows a list of distinct
-versions and allows to select one to be restored.
+It takes one path, looks for its backups, shows a list of distinct versions and
+allows to select one to be restored. Versions are based on the modification
+time of the file.
-Also allows to specify a time for automatic selection of the backup that has to
-be restored. If a time is specified, the script will automatically select the
-newest backup that is at least as old as the time value that is passed and
-restore it without further user interaction.
+It is also possible to specify a time for automatic selection of the backup
+that has to be restored. If a time is specified, the script will automatically
+select the newest backup that is at least as old as the time value that is
+passed and restore it without further user interaction.
+
+B<borg-restore.pl --update-cache> has to be executed regularly, ideally after
+creating or removing backups.
=cut