View on
MetaCPAN
perlancar > File-RsyBak > rsybak

Download:
File-RsyBak-0.31.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

rsybak - Backup files/directories with histories, using rsync

VERSION ^

This document describes version 0.31 of rsybak (from Perl distribution File-RsyBak), released on 2017-02-03.

SYNOPSIS ^

Usage:

 % rsybak [options] <source> <target>

OPTIONS ^

* marks required options.

Main options

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

--extra-rsync-opts-json=s

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

See --extra-rsync-opts.

--extra-rsync-opts-yaml=s

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

See --extra-rsync-opts.

--extra-rsync-opts=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.

--histories-json=s

Histories/history levels (JSON-encoded).

See --histories.

--histories-yaml=s

Histories/history levels (YAML-encoded).

See --histories.

--histories=i@

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.

--no-backup

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

--no-rotate

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

--source=s*

Director(y|ies) to backup.

--target=s*

Backup destination.

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format-options=s

Pass options to formatter.

--format=s

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

Default value:

 undef
--json

Equivalent to --format=json-pretty.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

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

    [200,"OK",[1,2,3],{"func.extra"=>4}]

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:

    [1,2,3]

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION ^

The script comes with a companion shell completer script (rsybak) for this script.

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

CONFIGURATION FILE ^

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/rsybak.conf, ~/rsybak.conf, or /etc/rsybak.conf.

All found files will be read and merged.

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

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

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

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)

ENVIRONMENT ^

RSYBAK_OPT => str

Specify additional command-line options.

FILES ^

~/.config/rsybak.conf

~/rsybak.conf

/etc/rsybak.conf

HOMEPAGE ^

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

SOURCE ^

Source repository is at https://github.com/perlancar/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) 2017 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.

syntax highlighting: