=head1 NAME C - Rsync fOr baCKup and Roll Light backup tool based on C. =head1 SYNOPSIS # rocknroll --init n tag dstdir # initialization # rocknroll [options] tag srcdir dstdir # backup # rocknroll --help # rocknroll --man =head1 DESCRIPTION C backups a remote directories tree C in local directory C. Using the C option of C, it manages a set of differential archives, named C, C, etc. C can contain several set of differential archives. For example, C can contain 2 sets named C and C. Before a C can be able to store an archive set, it must be formatted with the C<--init> option. =head1 ARGUMENTS =over 4 =item tag the name of the archive set. =item srcdir the topdir to backup, with the format of the srcdir of rsync : C<[[user@]hostname:]dir> =item dstdir the local destination directory for the backup. =back =head1 OPTIONS Almost command line options can be specified as well into the configuration file. =over 4 =item -c C use an alternate config file. By default, the config file C is searched in C<@/>, C<@/../etc/>, C, C (in this order) where C<@> is the directory containing the rocknroll script. =item --continue start again with an existing C<.tag.running> archive (useful after an abort) =item --debug debug mode =item --dry-run don't perfom any action, just say what it could be done =item --help print usage =item --man print the manual =item --no-links don't specify any C<--link-dest> option to C =item --no-roll don't roll the archives set =item --refresh only update the archive C (without deletion of any files on it). Don't roll the archives set. =item --ro C<"--opt1 --opt2 --opt3"> rsync option : pass some options to C (useful only as command line option) =item --update update archive C (with deletion of obsolete files). Don't roll up archives set. =back =head1 CONFIGURATION FILE Options are also taken from directives specified into C, a file located in C<@/>, C<@/../etc/>, C, C where C<@> is the directory contained the rocknroll script. The format of a line is : option=value or option value A C<#> starts a comment. =head2 Configuration file content Each following directive can be passed as well as an option on the command line. =over 4 =item link-dest C by default the C<--link-dest> option of C is set to the C directory. This option is to bypass this default. =item mail_from C set the email address of the sender for mail alerts =item mail_to C set the email address of the recipient for mail alerts =item max_runtime C set the max among of time that a backup can take. Older than this value, a C<.tag.running> temporary directory can be deleted. =item rsync_path C specify the path of the C command line (default C) =item rsync_retcode_ok C specify a list of return codes of C considered as OK codes. Each code not specified with C<--rsync_retcode_ok> or C<--rsync_retcode_warn> is considered as an error return code. =item rsync_retcode_warn C specify a list of return codes of C considered as warning codes. Each code not specified with C<--rsync_retcode_ok> or C<--rsync_retcode_warn> is considered as an error return code. =item ro_default C<"--opt1 --opt2"> pass some options to C (useful only in config file). Default is C<"--hard-links --archive -e ssh">. =item send_warn C<0|1> send alert on warning (default is send alert only on error) =item smtp_server C set the SMTP server =item use_syslog C<0|1> enable to talk to syslog =back =head1 ARCHIVE INITIALIZATION This operation is needed before a directory can be used as a backup destination. =over 4 =item --init C format a backup directory to receive C archives. =back =head1 FILES AND DIRECTORIES =over 4 =item rocknroll.conf the configuration file =item .C.ctl a control file located in the archive directory, related to the C archive set. =over 4 =item Note This file stores the number of archives declared at the initialization of the C archives set. It is useful to recovery a normal state, in case of some archives disappear. Normaly, the number stored in this file must match the number of current archives in the set. If not, a warning is sent. If this file is not found, it is re-create according of the current state of the archive set, and a warning is sent. =back =item .C.running the temporary directory (located in the archive directory) for the running rsync. =back =head1 EXAMPLES # rocknroll --init 7 daily /var/backup/myserver # rocknroll --init 4 weekly /var/backup/myserver # rocknroll --init 12 monthly /var/backup/myserver prepare the directory C to receive 3 sets of respectively 7 archives named C, 4 archives named C and 12 archives named monthly. # rocknroll daily myhost.mydomain:/ /var/backup/myserver perform a new backup of C, add it as C to the archive set into the local directory C, and roll the set C(forget the existing C) =head1 SEE ALSO C, . C and C have similar functionalities, and C has been the first on the place. But when I began to think about C, I've never heard of C. =head1 AUTHOR Jacquelin Charbonnel, C<< >> =head1 INSTALLATION To install this module, run the following commands: perl Makefile.PL make make test make install Alternatively, to install with Module::Build, you can use the following commands: perl Build.PL ./Build ./Build test ./Build install =head1 BUGS Please report any bugs or feature requests to C, or through the web interface at L. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT You can find documentation for this module with the perldoc command. perldoc Dir-Rocknroll You can also look for information at: =over 4 =item * AnnoCPAN: Annotated CPAN documentation L =item * CPAN Ratings L =item * RT: CPAN's request tracker L =item * Search CPAN L =back =head1 COPYRIGHT & LICENSE Copyright Jacquelin Charbonnel E jacquelin.charbonnel at math.cnrs.fr E This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info". As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the successive licensors have only limited liability. In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security. The fact that you are presently reading this means that you have had knowledge of the CeCILL-C license and that you accept its terms.