diff options
author | Florian Pritz <bluewind@xinu.at> | 2016-08-14 23:32:27 +0200 |
---|---|---|
committer | Florian Pritz <bluewind@xinu.at> | 2016-08-14 23:32:27 +0200 |
commit | a269667d2b88fab10079a993e89114b7cefbfcfe (patch) | |
tree | 47a1fdb42e20cd2f4cca1d8aaf3785391fb040fa | |
parent | f38ea4f75d4a44859b9a1c7ae56c1ebee1ab37e4 (diff) | |
download | bin-a269667d2b88fab10079a993e89114b7cefbfcfe.tar.gz bin-a269667d2b88fab10079a993e89114b7cefbfcfe.tar.xz |
borg-restore.pl: Update documentation
Signed-off-by: Florian Pritz <bluewind@xinu.at>
-rwxr-xr-x | borg-restore.pl | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/borg-restore.pl b/borg-restore.pl index ba4998c..d3a02ba 100755 --- a/borg-restore.pl +++ b/borg-restore.pl @@ -15,42 +15,40 @@ versions and allows to select one to be restored. 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. - -Backups are restored to their original destination if no --destination is given. -if that destination does not -exist. If restoration should be attempted to an existing destination, the -destination has to be passed as an argument. +newest backup that is at least as old as the time value that is passed and +restore it without further user interaction. =cut =head1 OPTIONS -=item C<--help>, C<-h> +=over 4 -Show help message +=item B<--help>, B<-h> -=back +Show help message. -=item C<--debug> +=item B<--debug> Enable debug messages. -=back - -=item C<--update-cache>, C<-u> +=item B<--update-cache>, B<-u> Update the lookup database. You should run this after creating or removing a backup. -=back - -=item C<--destination>, C<-d> +=item B<--destination=>I<path>, B<-d=>I<path> Restore the backup to 'path' instead of its original location. The destination either has to be a directory or missing in which case it will be created. The backup will then be restored into the directory with its original file or directory name. +=item B<--time=>I<timespec>, B<-t=>I<timespec> + +Automatically find the newest backup that is at least as old as I<timespec> +specifies. I<timespec> is a string of the form "<I<number>><I<unit>>" with I<unit> being one of the following: +s (seconds), min (minutes), h (hours), d (days), m (months = 31 days), y (year). Example: 5.5d + =back =head1 SYNOPSIS @@ -68,7 +66,7 @@ borg-restore.pl [options] <path> Time spec: Select the newest backup that is at least <time spec> old. Format: <number><unit> - Units: s (seconds), min (minutes), h (hours), d (days), m (months = 31 days) + Units: s (seconds), min (minutes), h (hours), d (days), m (months = 31 days), y (year) =cut |