man rsnapshot Command

Man page for apt-get rsnapshot Command

Man Page for rsnapshot in Linux

Ubuntu Man Command : man rsnapshot

Man Rsnapshot  Command

This tutorial shows the man page for man rsnapshot in linux.

Open terminal with 'su' access and type the command as shown below:
man rsnapshot

Result of the Command Execution shown below:

rsnapshot(1)                                                      rsnapshot(1)

rsnapshot remote filesystem snapshot utility

rsnapshot [ vtxqVD] [ c cfgfile] [command] [args]

rsnapshot is a filesystem snapshot utility. It can take incremental
snapshots of local and remote filesystems for any number of machines.

Local filesystem snapshots are handled with rsync(1). Secure remote
connections are handled with rsync over ssh(1), while anonymous rsync
connections simply use an rsync server. Both remote and local transfers
depend on rsync.

rsnapshot saves much more disk space than you might imagine. The amount
of space required is roughly the size of one full backup, plus a copy
of each additional file that is changed. rsnapshot makes extensive use
of hard links, so if the file doesn't change, the next snapshot is
simply a hard link to the exact same file.

rsnapshot will typically be invoked as root by a cron job, or series of
cron jobs. It is possible, however, to run as any arbitrary user with
an alternate configuration file.

All important options are specified in a configuration file, which is
located by default at /etc/rsnapshot.conf. An alternate file can be
specified on the command line. There are also additional options which
can be passed on the command line.

The command line options are as follows:

v verbose, show shell commands being executed

t test, show shell commands that would be executed

c path to alternate config file

x one filesystem, don't cross partitions within each backup point

q quiet, suppress non fatal warnings

V same as v, but with more detail

D a firehose of diagnostic information

/etc/rsnapshot.conf is the default configuration file. All parameters
in this file must be separated by tabs. /etc/rsnapshot.conf.default can
be used as a reference.

It is recommended that you copy /etc/rsnapshot.conf.default to
/etc/rsnapshot.conf, and then modify /etc/rsnapshot.conf to suit your

Here is a list of allowed parameters:

config_version Config file version (required). Default is 1.2

snapshot_root Local filesystem path to save all snapshots

include_conf Include another file in the configuration at
this point.

This is recursive, but you may need to be careful about paths
when specifying which file to include. We check to see if the
file you have specified is readable, and will yell an error if
it isn't. We recommend using a full path.

no_create_root If set to 1, rsnapshot won't create
snapshot_root directory

cmd_rsync Full path to rsync (required)

cmd_ssh Full path to ssh (optional)

cmd_cp Full path to cp (optional, but must be GNU

If you are using Linux, you should uncomment cmd_cp. If you are
using a platform which does not have GNU cp, you should leave
cmd_cp commented out.

With GNU cp, rsnapshot can take care of both normal files and
special files (such as FIFOs, sockets, and block/character
devices) in one pass.

If cmd_cp is disabled, rsnapshot will use its own built in
function, native_cp_al() to backup up regular files and
directories. This will then be followed up by a separate call
to rsync, to move the special files over (assuming there are

cmd_rm Full path to rm (optional)

cmd_logger Full path to logger (optional, for syslog

cmd_du Full path to du (optional, for disk usage

cmd_rsnapshot_diff Full path to rsnapshot diff (optional)


Full path (plus any arguments) to preexec script (optional).
This script will run immediately before each backup operation
(but not any rotations).


Full path (plus any arguments) to postexec script (optional).
This script will run immediately after each backup operation
(but not any rotations).

interval [name] [number]

"name" refers to the name of this interval (e.g., hourly,
daily). "number" is the number of snapshots for this type of
interval that will be stored. The value of "name" will be the
command passed to rsnapshot to perform this type of backup.

Example: interval hourly 6


Related Topics

Apt Get Commands