'\" t
.\"     Title: backupchecker
.\"    Author: Carl Chenet <chaica@backupchecker.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 02/27/2015
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "BACKUPCHECKER" "1" "02/27/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
backupchecker \- fully automated backup checker
.SH "SYNOPSIS"
.sp
backupchecker [\-c DIR] [\-l FILE] [\-G] ARG1 ARG2
.SH "DESCRIPTION"
.sp
Backup Checker parses backups (archives and file tree) to perform several different checks in order to verify your backup integrity and its associated content\&.
.SH "OPTIONS"
.PP
\fB\-c \fR\fB\fIDIR\fR\fR\fB, \-\-configpath \fR\fB\fIDIR\fR\fR
.RS 4
the path to the configurations
.RE
.PP
\fB\-C \fR\fB\fIDIR\fR\fR\fB, \-\-output\-conf\-dir \fR\fB\fIDIR\fR\fR
.RS 4
the directory to store the configuration file
.RE
.PP
\fB\-d \fR\fB\fIDELIMITER\fR\fR\fB, \-\-delimiter \fR\fB\fIDELIMITER\fR\fR
.RS 4
delimiter of the fields for the list of files
.RE
.PP
\fB\-E \fR\fB\fIFILE\fR\fR\fB, \-\-exceptions\-file \fR\fB\fIFILE\fR\fR
.RS 4
delimiter of the fields for the list of files
.RE
.PP
\fB\-g, \-\-gen\-list\fR
.RS 4
generate a list of files inside a backup
.RE
.PP
\fB\-G, \-\-gen\-full\fR
.RS 4
generate the configuration file and the list of files for the backup
.RE
.PP
\fB\-H, \-\-hashes\fR
.RS 4
generate the hash sum of each encountered file in the backup
.RE
.PP
\fB\-\-hashtype \fR\fB\fIHASHTYPE\fR\fR
.RS 4
the type of the hash sum to use while generating configurations for the archive
.RE
.PP
\fB\-l \fR\fB\fIFILE\fR\fR\fB, \-\-log \fR\fB\fIFILE\fR\fR
.RS 4
the log file
.RE
.PP
\fB\-L \fR\fB\fIDIR\fR\fR\fB, \-\-output\-list\-dir \fR\fB\fIDIR\fR\fR
.RS 4
the directory to store the list of files inside an archive or tree
.RE
.PP
\fB\-n \fR\fB\fINAME\fR\fR\fB, \-\-configuration\-name \fR\fB\fINAME\fR\fR
.RS 4
the name to use to name the \&.conf and \&.list generated by \-g or \-G options (default is the name of the archive)
.RE
.PP
\fB\-O \fR\fB\fIDIR\fR\fR\fB, \-\-output\-list\-and\-conf\-dir \fR\fB\fIDIR\fR\fR
.RS 4
the directory to store the configuration file and the list of files inside an archive or tree
.RE
.PP
\fB\-v, \-\-version\fR
.RS 4
the version of Backup Checker
.RE
.SH "EXAMPLES"
.sp
Generate the list of files (\&.conf and \&.list files) and their attributes inside a backup
.sp
$ backupchecker \-G /backups/monthly\-backup\&.tar\&.gz
.sp
Launch Backup Checker indicating your configuration directory and your log file
.sp
$ backupchecker \-c /etc/brebis/ \-l /var/log/brebis\&.log
.sp
Verify a remote backup by FTP
.sp
$ wget \-\-quiet \-O \- ftp://user:pass@server/backup\&.tar\&.gz | backupchecker \-c /etc/brebis/ \-l /var/log/brebis\&.log
.SH "AUTHOR"
.sp
Carl Chenet <chaica@backupchecker\&.com[]>
.SH "RESSOURCES"
.sp
Backup Checkup project homepage : https://github\&.com/backupchecker/backupchecker
.SH "LICENSE"
.sp
Copyright \(co 2015-2017 Carl Chenet <chaica@backupchecker\&.com> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License\&. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&. You should have received a copy of the GNU General Public License along with this program\&. If not, see http://www\&.gnu\&.org/licenses/\&.
.RE