NAME

       gb-backup-generator - Program to generate backups or archives using configured generator
       units according to given schedule.

SYNOPSIS

       gb-backup-generator --ConfigDir dir

DESCRIPTION

       This is the manual page for the gb-backup-generator command. For more details see
       documentation at /usr/share/doc/guerillabackup. The generator is responsible to keep track
       over all scheduled backup tasks (units), to invoke them and write the created backup data
       stream to the data sink, usually the file system. The generator supports generation of
       encrypted backups, management of information about the backed-up element, adds hashes to
       support detection of missing and manipulated backups. With that functions, confidentiality
       and integrity can be protected, also providing non-repudiation features.

OPTIONS

       --ConfigDir dir
           This optional parameter specifies an alternative configuration loading directory
           instead of /etc/guerillabackup. The directory has to contain the main configuration
           file (config), the units subdirectory.

FILES

       /etc/guerillabackup/config
           The main configuration file for all guerillabackup tools. Use
           /etc/guerillabackup/config.template to create it. The template also contains the
           documentation for each available parameter.

       /etc/guerillabackup/units/[name]
           The units directory contains the enabled backup data generation units. To enable a
           unit, a symbolic link to the unit definition file has to be created. The name of the
           symbolic link has to consist only of letters and numbers. For example, to enable
           LogfileBackupUnit for log-file archiving, one could use "ln -s --
           /usr/lib/guerillabackup/lib/guerillabackup/LogfileBackupUnit.py LogfileBackupUnit".

           For units with an associated configuration file named "[unitname].config",
           configuration parameters from the main configuration file can be overridden within the
           unit-specific configuration. For all standard units, /etc/guerillabackup/units
           contains templates for unit configuration files.

           It is also possible to link a the same unit definition file more than once using
           different symbolic link names. Usually this only makes sense when each of those units
           has a different unit configuration file.

       /etc/systemd/system/guerillabackup-generator.service
           On systemd installations, this is the systemd configuration for automatic startup of
           the gb-backup-generator service. Usually it is not enabled by default. To enable use
           "systemctl enable guerillabackup-generator.service".

BUGS

       For guerillabackup setups installed from packages, e.g. .deb or .rpm files usually
       installed via package management software, e.g. apt-get, aptitude, rpm, yast, please
       report bugs to the package maintainer.

       For setups from unpackaged software trunk, please report at
       https://github.com/halfdog/guerillabackup/issues.

SEE ALSO

       gb-transfer-service(1)

AUTHOR

       halfdog  <me@halfdog.net>
           Wrote this manual page.

COPYRIGHT

       Copyright © 2016-2023 halfdog

       This manual page was written for guerillabackup system on Linux systems, e.g. Debian.

       Permission is granted to copy, distribute and/or modify this document under the terms of
       the Lesser GNU General Public License, Version 3.

       On Debian systems, the complete text of the Lesser GNU General Public License can be found
       in /usr/share/common-licenses/LGPL-3.