faubackup.conf5

Usage

Overview

Configuration is read from /etc/faubackup.conf. Blank lines and lines starting with `#' are ignored. Perl-Syntax is used to change things: `$key = value;'. The file must start with package FAUBACKUP; and end with 1;.

These settings are supported:

$backup = string;

The default destination for backups. This is used when no destination directory is specified on the command line. It may contain the special strings MACHINE and/or DIR, which are replaced by the hostname or directory-name of the backup source. Slashes in the source directory name will be converted to dashes. Default is "/backup/MACHINE:DIR".

$autocreate = number;

If non-zero, faubackup will create the destination directory, if it doesn't already exist. Default is enabled (1).

$keepyears = number;

Yearly backups are kept for at least number years when cleaning. Default is to keep two yearly backups.

$keepmonths = number;

Monthly backups are kept for at least number months when cleaning. Default is to keep twelve monthly backups.

$keepweeks = number;

Weekly backups are kept for at least number weeks when cleaning. Default is to keep four weekly backups.

$keepdays = number;

Daily backups are kept for at least number days when cleaning. Default is to keep seven daily backups.

$keeplastofday = boolean;

If this is nonzero, the last daily backup (instead of the first) will be kept when cleaning. Default is zero (keep the first even for daily backups).

$rsh = string;

The command executed to start commands on remote machines. This may be overwritten by the environment Variable FAUBACKUP_RSH. Default is to use "rsh".

$gather = string;

The command used to gather the files. Default is "faubackup-gather".

$scatter = string;

The command used to scatter the files. Default is "faubackup-scatter".

$find = string;

The command used to compute the file list to backup. Default is "faubackup-find". This command must list all files on stdout, separated by NUL characters. The last entry sent MUST be the current directory, "."!

$getroot = string;

The command used to obtain root access. Can be set to "sudo" or similar. There is no default.

@ignore = list of strings;

Arguments passed to the $find Command. For faubackup-find, this is a list of expressions not to be processed. See faubackup-find(8) for details.

$atime_preserve = number;

If this variable is non-null then --atime-preserve will be passed to faubackup-gather