#!perl
# Note: This script is a CLI interface to Riap function /File/RsyBak/backup
# and generated automatically using App::GenPericmdScript version 0.04
our $DATE = '2015-03-18'; # DATE
our $VERSION = '0.24'; # VERSION
use 5.010001;
use strict;
use warnings;
use Perinci::CmdLine::Classic;
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME} = 0;
Perinci::CmdLine::Classic->new(
url => "/File/RsyBak/backup",
)->run;
# ABSTRACT: Backup files/directories with histories, using rsync
# PODNAME: rsybak
__END__
=pod
=encoding UTF-8
=head1 NAME
rsybak - Backup files/directories with histories, using rsync
=head1 VERSION
This document describes version 0.24 of rsybak (from Perl distribution File-RsyBak), released on 2015-03-18.
=head1 SYNOPSIS
Usage:
% rsybak [options] <source> <target>
Examples:
% rsybak /home/jajang/mydata /backup/jajang/mydata
=head1 OPTIONS
C<*> marks required options.
=over
=item B<--config-path>=I<s>
Set path to configuration file.
Can be specified multiple times.
=item B<--config-profile>=I<s>
Set configuration profile to use.
=item B<--extra-dir>
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.
=item B<--extra-rsync-opts-json>=I<s>
Pass extra options to rsync command (JSON-encoded).
See C<--extra-rsync-opts>.
=item B<--extra-rsync-opts-yaml>=I<s>
Pass extra options to rsync command (YAML-encoded).
See C<--extra-rsync-opts>.
=item B<--extra-rsync-opts>=I<s@>
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'].
Can be specified multiple times.
=item B<--format-options>=I<s>
Pass options to formatter.
=item B<--format>=I<s>
Choose output format, e.g. json, text.
=item B<--help>, B<-h>, B<-?>
Display this help message.
=item B<--histories-json>=I<s>
Histories/history levels (JSON-encoded).
See C<--histories>.
=item B<--histories-yaml>=I<s>
Histories/history levels (YAML-encoded).
See C<--histories>.
=item B<--histories>=I<s@>
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).
Can be specified multiple times.
=item B<--json>
Equivalent to --format=json-pretty.
=item B<--no-backup>
If backup=1 and rotate=0 then will only create new backup without rotating
histories.
=item B<--no-config>
Do not use any configuration file.
=item B<--no-rotate>
If backup=0 and rotate=1 then will only do history rotating.
=item B<--source>=I<s>*
Director(y|ies) to backup.
=item B<--target>=I<s>*
Backup destination.
=item B<--version>, B<-v>
=back
=head1 FILES
~/.conf
/etc/.conf
=head1 COMPLETION
This script has shell tab completion capability with support for several shells.
=head2 bash
To activate bash completion for this script, put:
complete -C rsybak rsybak
in your bash startup (e.g. C<~/.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.
It is recommended, however, that you install L<shcompgen> which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell completion for their included scripts (using C<shcompgen>) at installation time, so you can immadiately have tab completion.
=head2 tcsh
To activate tcsh completion for this script, put:
complete rsybak 'p/*/`rsybak`/'
in your tcsh startup (e.g. C<~/.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.
It is also recommended to install C<shcompgen> (see above).
=head2 other shells
For fish and zsh, install C<shcompgen> as described above.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/File-RsyBak>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-File-RsyBak>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
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.
=cut