rsybak - Backup files/directories with histories, using rsync
This document describes version 0.23 of rsybak (from Perl distribution File-RsyBak), released on 2015-01-03.
Usage:
% rsybak [options] <source> <target>
Examples:
% rsybak /home/jajang/mydata /backup/jajang/mydata
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Whether to force creation of source directory in target.
If set to 1, then backup(source => '/a', target => '/backup/a') will create another 'a' directory in target, i.e. /backup/a/current/a. Otherwise, contents of a/ will be directly copied under /backup/a/current/.
Will always be set to 1 if source is more than one, but default to 0 if source is a single directory. You can set this to 1 to so that behaviour when there is a single source is the same as behaviour when there are several sources.
Pass extra options to rsync command (JSON-encoded).
See --extra-rsync-opts.
--extra-rsync-opts
Pass extra options to rsync command (YAML-encoded).
Pass extra options to rsync command.
Extra options to pass to rsync command when doing backup. Note that the options will be shell quoted, , so you should pass it unquoted, e.g. ['--exclude', '/Program Files'].
Pass options to formatter.
Choose output format, e.g. json, text.
Display this help message.
Histories/history levels (JSON-encoded).
See --histories.
--histories
Histories/history levels (YAML-encoded).
Histories/history levels.
Default value:
[-7, 4, 3]
Specifies number of backup histories to keep for level 1, 2, and so on. If number is negative, specifies number of days to keep instead (regardless of number of histories).
If backup=1 and rotate=0 then will only create new backup without rotating histories.
Do not use any configuration file.
If backup=0 and rotate=1 then will only do history rotating.
Director(y|ies) to backup.
Backup destination.
/etc/rsybak.conf
~/rsybak.conf
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C rsybak rsybak
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
~/.bashrc
It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
shcompgen
To activate tcsh completion for this script, put:
complete rsybak 'p/*/`rsybak`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/File-RsyBak.
Source repository is at https://github.com/sharyanto/perl-File-RsyBak.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-RsyBak
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install File::RsyBak, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::RsyBak
CPAN shell
perl -MCPAN -e shell install File::RsyBak
For more information on module installation, please visit the detailed CPAN module installation guide.