'\" t
.\"     Title: GB-BACKUP-GENERATOR
.\"    Author: halfdog  <me@halfdog.net>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/16/2023
.\"    Manual: User Manual
.\"    Source: guerillabackup
.\"  Language: English
.\"
.TH "GB\-BACKUP\-GENERATO" "1" "09/16/2023" "guerillabackup" "User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gb-backup-generator \- Program to generate backups or archives using configured generator units according to given schedule\&.
.SH "SYNOPSIS"
.HP \w'\fBgb\-backup\-generator\fR\ 'u
\fBgb\-backup\-generator\fR \fB\-\-ConfigDir\ \fR\fB\fIdir\fR\fR
.SH "DESCRIPTION"
.PP
This is the manual page for the
\fBgb\-backup\-generator\fR
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\&.
.SH "OPTIONS"
.PP
\fB\-\-ConfigDir \fR\fB\fIdir\fR\fR
.RS 4
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\&.
.RE
.SH "FILES"
.PP
/etc/guerillabackup/config
.RS 4
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\&.
.RE
.PP
/etc/guerillabackup/units/[name]
.RS 4
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"\&.
.sp
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\&.
.sp
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\&.
.RE
.PP
/etc/systemd/system/guerillabackup\-generator\&.service
.RS 4
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"\&.
.RE
.SH "BUGS"
.PP
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\&.
.PP
For setups from unpackaged software trunk, please report at
\m[blue]\fB\%https://github.com/halfdog/guerillabackup/issues\fR\m[]\&.
.SH "SEE ALSO"
.PP
\fBgb-transfer-service\fR(1)
.SH "AUTHOR"
.PP
\fBhalfdog \fR <\&me@halfdog\&.net\&>
.RS 4
Wrote this manual page\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2016-2023 halfdog
.br
.PP
This manual page was written for guerillabackup system on Linux systems, e\&.g\&. Debian\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the Lesser GNU General Public License, Version 3\&.
.PP
On Debian systems, the complete text of the Lesser GNU General Public License can be found in
/usr/share/common\-licenses/LGPL\-3\&.
.sp