From d919cb733de7622835aa6148ed939051d67cb64f Mon Sep 17 00:00:00 2001 From: Florian Pritz Date: Sun, 2 Apr 2017 23:39:15 +0200 Subject: Move configuration documentation to Settings package Signed-off-by: Florian Pritz --- script/borg-restore.pl | 58 +------------------------------------------------- 1 file changed, 1 insertion(+), 57 deletions(-) (limited to 'script') diff --git a/script/borg-restore.pl b/script/borg-restore.pl index 7093391..ded825e 100755 --- a/script/borg-restore.pl +++ b/script/borg-restore.pl @@ -74,63 +74,7 @@ s (seconds), min (minutes), h (hours), d (days), m (months = 31 days), y (year). =head1 CONFIGURATION -borg-restore.pl searches for configuration files in the following locations in -order. The first file found will be used, any later ones are ignored. If no -files are found, defaults are used. - -=over - -=item * $XDG_CONFIG_HOME/borg-restore.cfg - -=item * /etc/borg-restore.cfg - -=back - -=head2 Configuration Options - -You can set the following options in the config file. - -Note that the configuration file is parsed as a perl script. Thus you can also -use any features available in perl itself. - -=over - -=item C<$borg_repo> - -This specifies the URL to the borg repo as used in other borg commands. If you -use the $BORG_REPO environment variable leave this empty. - -=item C<$cache_path_base> - -This defaults to "C<$XDG_CACHE_HOME>/borg-restore.pl". It contains the lookup database. - -=item C<@backup_prefixes> - -This is an array of prefixes that need to be added when looking up a file in the -backup archives. If you use filesystem snapshots and the snapshot for /home is -located at /mnt/snapshots/home, you have to add the following: - -# In the backup archives, /home has the path /mnt/snapshots/home -{regex => "^/home/", replacement => "mnt/snapshots/home/"}, - -The regex must always include the leading slash and it is suggested to include -a tailing slash as well to prevent clashes with directories that start with the -same string. The first regex that matches for a given file is used. This -setting only affects lookups, it does not affect the creation of the database -with --update-database. - -=back - -=head2 Example Configuration - - $borg_repo = "/path/to/repo"; - $cache_path_base = "/mnt/somewhere/borg-restore.pl-cache"; - @backup_prefixes = ( - {regex => "^/home/", replacement => "mnt/snapshots/home/"}, - # /boot is not snapshotted - {regex => "^/boot", replacement => ""}, - {regex => "^/", replacement => "mnt/snapshots/root/"}, - ); +For configuration options please see L. =head1 LICENSE -- cgit v1.2.3-24-g4f1b