perlancar > File-RsyBak > rsybak


Annotate this POD


View/Report Bugs


rsybak - Backup files/directories with histories, using rsync


This document describes version 0.30 of rsybak (from Perl distribution File-RsyBak), released on 2015-10-29.



 % rsybak [options] <source> <target>


 % rsybak /home/jajang/mydata /backup/jajang/mydata
 ERROR 500: Error: Can't create target directory : No such file or directory


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.

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.


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.



Specify additional command-line options


This script can read configuration file, which by default is searched at ~/.config/rsybak.conf, ~/rsybak.conf or /etc/rsybak.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)
 naked_res (see --naked-res)
 rotate (see --no-rotate)
 source (see --source)
 target (see --target)






Please visit the project's homepage at


Source repository is at


Please report any bugs or feature requests on the bugtracker website

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 <>


This software is copyright (c) 2015 by

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.


* marks required options.

Configuration options


Set path to configuration file.

Can be specified multiple times.


Set configuration profile to use.


Do not use any configuration file.

Environment options


Do not read environment for default options.

Output options


Pass options to formatter.


Choose output format, e.g. json, text.

Default value:


Equivalent to --format=json-pretty.


When outputing as JSON, strip result envelope.

Default value:


By default, when outputing as JSON, the full enveloped result is returned, e.g.:


The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:


Other options


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.


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

See --extra-rsync-opts.


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.

--help, -h, -?

Display help message and exit.


Histories/history levels (JSON-encoded).

See --histories.


Histories/history levels (YAML-encoded).

See --histories.


Histories/history levels.

Default value:


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.


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


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


Director(y|ies) to backup.


Backup destination.

--version, -v

Display program's version and exit.

syntax highlighting: