BEAM

NAME
SYNOPSIS
DESCRIPTION
COMMANDS
OPTIONS
FILES
ENVIRONMENT
SEE ALSO
AUTHORS
BUG REPORTS

NAME

beam − a backup manager

SYNOPSIS

beam backup [options]

beam restore [options]

beam list [options]

beam s3 [options]

beam help COMMAND

beam [−h] [−−help] [−V] [−−version]

DESCRIPTION

Backup Easy And Manageable is a suite of backup programs written in reasonably portable shell language with the purpose of making backup process as easy as possible.

All backup operations are controlled by the beam utility, which acts as a dispatcher between programs responsible for particular tasks. The actual task is specified as a command, i.e. a command verb given as the first argument to the program. For example, beam backup creates a backup.

Beam operates on backup items. An item is a set of files, which should be handled together. The way to handle these files during backup or restore is defined by the item type. For example, the basic item type is fs (file system), which implies archiving all files comprising the item into a single tar(1) archive. There are special item types for MySQL and PostgreSQL databases, etc.

Beam is a modular system. New item types can easily be defined by providing a module which defines how they should be handled during backup and restore. A module is a shell script named after the item type and placed in the /usr/local/lib/beam directory.

The backup process is controlled by the configuration file /usr/local/etc/beam.conf. This file is a set of shell variable assignments which define the items to include in the backup.

For a detailed description of beam configuration file, backup item definitions and module system, see beam.conf(5).

COMMANDS

backup

Create a backup. See beam−backup(1).

restore

Restore files from backup. See beam−restore(1).

list

List items included in the backup. See beam−list(1).

s3

Mount or unmount a backup s3 bucket. This command is available only if beam was configured with the −−with-s3 option. See beam−s3(1).

help command

Display help page for a particular command.

OPTIONS

−h, −−help

Display a short help summary.

−V, −−version

Display program version.

FILES

/usr/local/etc/beam.conf

Default configuration file.

/usr/local/lib/beam

Backup module directory.

ENVIRONMENT

BEAM_CONFIG

If defined, this variable supplies full pathname of the configuration file to use instead of the default /usr/local/etc/beam.conf.

SEE ALSO

beam−backup(1), beam−restore(1), beam−s3(1), beam−module(5), beam.conf(5).

AUTHORS

Sergey Poznyakoff

BUG REPORTS

Report bugs to <gray@gnu.org.ua>.


Manpage server at Ulysses.gnu.org.ua.

Powered by mansrv 1.0