Commit | Line | Data |
---|---|---|
a8447303 MW |
1 | .ie t .ds o \(bu |
2 | .el .ds o o | |
3 | .de hP | |
4 | .IP | |
5 | \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c | |
6 | .. | |
7 | .TH update-bkp-index 8 "25 January 2013" rsync-backup | |
8 | .SH NAME | |
9 | update-bkp-index \- create or update the rsync-backup index database | |
10 | .SH SYNOPSIS | |
11 | The | |
12 | .BR rsync-backup (8) | |
13 | program can maintain an index database which keeps track of which dumps | |
14 | are on which backup volumes. | |
15 | .PP | |
16 | The | |
17 | .B update-bkp-index | |
18 | program updates this database from the currently mounted backup volume, | |
19 | creating or upgrading it if necessary. | |
20 | .PP | |
21 | The program ignores any command-line arguments it's given, but it makes | |
22 | use of a number of environment variables. | |
23 | .TP | |
24 | .B INDEXDB | |
25 | The name of a SQLite database initialized by | |
26 | .BR update-bkp-index (8) | |
27 | in which an index is maintained of which dumps are on which backup | |
28 | volumes. If the file doesn't exist, then no index is maintained. The | |
29 | default is | |
30 | .IB localstatedir /lib/bkp/index.db | |
31 | where | |
32 | .I localstatedir | |
33 | is the state directory configured at build time. | |
34 | .TP | |
35 | .B METADIR | |
36 | The metadata directory for the currently mounted backup volume. | |
37 | The default is | |
38 | .IB mntbkpdir /meta | |
39 | where | |
40 | .I mntbkpdir | |
41 | is the backup mount directory configured at build time. | |
42 | .TP | |
43 | .B STOREDIR | |
44 | Where the actual backup trees should be stored. See the section on | |
45 | .B Archive structure | |
46 | below. | |
47 | The default is | |
48 | .IB mntbkpdir /store | |
49 | where | |
50 | .I mntbkpdir | |
51 | is the backup mount directory configured at build time. | |
52 | .TP | |
53 | .B VOLUME | |
54 | The name of the current volume. The default is to read this from the | |
55 | file | |
56 | .IB METADIR /volume | |
57 | once at the start of the backup run. | |
58 | .SH SEE ALSO | |
59 | .BR rsync-backup (8). | |
60 | .SH AUTHOR | |
61 | Mark Wooding, <mdw@distorted.org.uk> |