.ie t .ds o \(bu
.el .ds o o
.de hP
.IP
\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
..
.TH update-bkp-index 8 "25 January 2013" rsync-backup
.SH NAME
update-bkp-index \- create or update the rsync-backup index database
.SH SYNOPSIS
The
.BR rsync-backup (8)
program can maintain an index database which keeps track of which dumps
are on which backup volumes.
.PP
The
.B update-bkp-index
program updates this database from the currently mounted backup volume,
creating or upgrading it if necessary.
.PP
The program ignores any command-line arguments it's given, but it makes
use of a number of environment variables.
.TP
.B INDEXDB
The name of a SQLite database initialized by
.BR update-bkp-index (8)
in which an index is maintained of which dumps are on which backup
volumes.  If the file doesn't exist, then no index is maintained.  The
default is
.IB localstatedir /lib/bkp/index.db
where
.I localstatedir
is the state directory configured at build time.
.TP
.B METADIR
The metadata directory for the currently mounted backup volume.
The default is
.IB mntbkpdir /meta
where
.I mntbkpdir
is the backup mount directory configured at build time.
.TP
.B STOREDIR
Where the actual backup trees should be stored.  See the section on
.B Archive structure
below.
The default is
.IB mntbkpdir /store
where
.I mntbkpdir
is the backup mount directory configured at build time.
.TP
.B VOLUME
The name of the current volume.  The default is to read this from the
file
.IB METADIR /volume
once at the start of the backup run.
.SH SEE ALSO
.BR rsync-backup (8).
.SH AUTHOR
Mark Wooding, <mdw@distorted.org.uk>