perlancar

NAME

rsybak - Backup files/directories with histories, using rsync

VERSION

This document describes version 0.26 of rsybak (from Perl distribution File-RsyBak), released on 2015-08-17.

SYNOPSIS

Usage:

 % rsybak [options] <source> <target>

Examples:

 % rsybak /home/jajang/mydata /backup/jajang/mydata

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

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.

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.

tcsh

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.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

ENVIRONMENT

=> str

Specify additional command-line options

CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/.conf, ~/.conf or /etc/.conf (can be changed by specifying --config-path). All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

Configuration file is in the format of IOD, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

List of available configuration parameters:

 backup (see --no-backup)
 extra_dir (see --extra-dir)
 extra_rsync_opts (see --extra-rsync-opts)
 format (see --format)
 format_options (see --format-options)
 histories (see --histories)
 rotate (see --no-rotate)
 source (see --source)
 target (see --target)

FILES

~/.config/.conf

~/.conf

/etc/.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/File-RsyBak.

SOURCE

Source repository is at https://github.com/sharyanto/perl-File-RsyBak.

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

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.

OPTIONS

* marks required options.

Configuration options

--config-path=filename

{en_US Set path to configuration file}.

Can be specified multiple times.

--config-profile=s

{en_US Set configuration profile to use}.

--no-config

{en_US Do not use any configuration file}.

Environment options

--no-env

{en_US Do not read environment for default options}.

Output options

--format-options=s

{en_US Pass options to formatter}.

--format=s

{en_US Choose output format, e.g. json, text}.

Default value:

 undef
--json

{en_US Equivalent to --format=json-pretty}.

Other options

--extra-dir

{en_US Whether to force creation of source directory in target}.

{en_US 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. }

--extra-rsync-opts-json=s

{en_US Pass extra options to rsync command} (JSON-encoded).

See --extra-rsync-opts.

--extra-rsync-opts-yaml=s

{en_US Pass extra options to rsync command} (YAML-encoded).

See --extra-rsync-opts.

--extra-rsync-opts=s@

{en_US Pass extra options to rsync command}.

{en_US 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.

--help, -h, -?

{en_US Display help message and exit}.

--histories-json=s

{en_US Histories/history levels} (JSON-encoded).

See --histories.

--histories-yaml=s

{en_US Histories/history levels} (YAML-encoded).

See --histories.

--histories=s@

{en_US Histories/history levels}.

Default value:

 [-7,4,3]

{en_US 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.

--no-backup

{en_US If backup=1 and rotate=0 then will only create new backup without rotating histories. }

--no-rotate

{en_US If backup=0 and rotate=1 then will only do history rotating. }

--source=s*

{en_US Director(y|ies) to backup}.

--target=s*

{en_US Backup destination}.

--version, -v

{en_US Display program's version and exit}.