# $Id: README,v 1.3 2003/04/23 00:21:52 sharky Exp $
# Copyright (c) 2002-2003 Jeremy Lain

                           Notes for bkp

PRESENTATION
------------

bkp is a set of scripts for making backups, released under the terms of the
GNU Public License (GPL). The COPYING file contains the full text of this
license.

The configuration is controlled by /etc/backup.conf. An annotated example of
this file can be found in the "examples" directory.

The output of the backup is stored in subdirectories of:
$savedir/`hostname`/

A 'section' is an entry in the configuration file, for example 'home' or 'conf'
in the given example, which will be backed up in a subdirectory of the same
name. For each section, one defines a set of 'targets', that is directories
on the local filesystem that will be backed up as .tar.bz2's.

REQUIREMENTS
------------

To run, the scripts require:

* Perl and the modules :
 - Config::General (libconfig-general-perl on Debian systems)
 - Date::Format (libtimedate-perl on Debian systems)

THE SCRIPTS
-----------

The worker scripts:
* bkp-database : makes a dump of one or more databases to
                 $savedir/`hostname`/db
* bkp-section : makes a backup of one or more sections to
                $savedir/`hostname/the_section
* bkp-remote : retrieves backups from one or more remote backups to
               $savedir/the_host

