1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
# NAME
borg-restore.pl - Restore paths from borg backups
# SYNOPSIS
borg-restore.pl \[options\] <path>
Options:
--help, -h short help message
--debug show debug messages
--quiet show only warnings and errors
--detail Output additional detail for some operations
(currently only --list)
--json Output JSON instead of human readable text
(currently only --list)
--update-cache, -u update cache files
--list [pattern] List paths contained in the backups, optionally
matching an SQLite LIKE pattern
--destination, -d <path> Restore backup to directory <path>
--time, -t <timespec> Automatically find newest backup that is at least
<time spec> old
--adhoc Do not use the cache, instead provide an
unfiltered list of archive to choose from
--version display the version of the program
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), y (year)
# EXAMPLE USAGE
> borg-restore.pl bin/backup.sh
0: Sat. 2016-04-16 17:47:48 +0200 backup-20160430-232909
1: Mon. 2016-08-15 16:11:29 +0200 backup-20160830-225145
2: Mon. 2017-02-20 16:01:04 +0100 backup-20170226-145909
3: Sat. 2017-03-25 14:45:29 +0100 backup-20170325-232957
Enter ID to restore (Enter to skip): 3
INFO Restoring home/flo/bin/backup.sh to /home/flo/bin from archive backup-20170325-232957
# DESCRIPTION
borg-restore.pl helps to restore files from borg backups.
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.
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.
**borg-restore.pl --update-cache** has to be executed regularly, ideally after
creating or removing backups.
[App::BorgRestore](https://metacpan.org/pod/App::BorgRestore) provides the base features used to implement this script.
It can be used to build your own restoration script.
# OPTIONS
- **--help**, **-h**
Show help message.
- **--debug**
Enable debug messages.
- **--quiet**
Reduce output by showing only show warnings and above (errors).
- **--detail**
Output additional detail information with some operations. Refer to the
specific options for more information. Currently only works with **--list**
- **--json**
Output JSON instead of human readable text with some operations. Refer to the
specific options for more information. Currently only works with **--list**
- **--update-cache**, **-u**
Update the lookup database. You should run this after creating or removing a backup.
- **--list** **\[pattern\]**
List paths contained in the backups, optionally matching an SQLite LIKE
pattern. If no % occurs in the pattern, the patterns is automatically wrapped
between two % so it may match anywhere in the path.
If **--detail** is used, also outputs which archives contain a version of the
file. If the same version is part of multiple archives, only one archive is
shown.
If **--json** is used, the output is JSON. Can also be combined with **--detail**.
- **--destination=**_path_, **-d **_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.
- **--time=**_timespec_, **-t **_timespec_
Automatically find the newest backup that is at least as old as _timespec_
specifies. _timespec_ is a string of the form "<_number_><_unit_>" with _unit_ being one of the following:
s (seconds), min (minutes), h (hours), d (days), m (months = 31 days), y (year). Example: 5.5d
- **--adhoc**
Disable usage of the database. In this mode, the list of archives is fetched
directly from borg at run time. Use this when the cache has not been created
yet and you want to restore a file without having to manually call borg
extract. Using this option will show all archives that borg knows about, even
if they do not contain the file that shall be restored.
- **--version**
Output the program version.
# CONFIGURATION
For configuration options please see [App::BorgRestore::Settings](https://metacpan.org/pod/App::BorgRestore::Settings).
# LICENSE
Copyright (C) 2016-2018 Florian Pritz <bluewind@xinu.at>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
See LICENSE for the full license text.
|
