---
name: "rsbackup.cron"
section: "1"
platform: "linux"
package: "rsbackup"
version: "10.0-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rsbackup.cron"
---

# rsbackup.cron(1)

cron script for rsbackup

## NAME

rsbackup.cron - cron script for rsbackup

## SYNOPSIS

**rsbackup.cron** \[*OPTIONS*\] *FREQUENCY*

## DESCRIPTION

**rsbackup.cron** is invoked from cron to run automated backups, pruning and reporting.

*FREQUENCY* must be one of **hourly**, **daily**, **weekly** or **monthly**, corresponding to the frequency it is invoked at.

## OPTIONS

- **--dry-run, -n**

  Passes the **--dry-run** option to **rsbackup**.

- **--verbose, -v**

  Displays the **rsbackup** command before executing it.

- **--help, -h**

  Displays a usage message and terminates.

- **--version, -V**

  Display version string.

## CONFIGURATION

Configuration is read from */etc/rsbackup/defaults*. This is a shell script fragment and it should define the following variables:

- **backup**

  Defines the frequency to *attempt* backups, i.e. to run **rsbackup --backup**. The default is **hourly**.

-

  Use backup policies for full control over the actual backup frequency.

- **report**

  Defines the frequency to send an email report. The default is **daily**.

- **email**

  Defines the destination address for the email report.

- **prune**

  Defines the frequency of pruning old backups. The default is **daily**.

- **prune\_incomplete**

  Defines the frequency of pruning incomplete backups. The default is **dweekly**.

### Frequencies

The possible frequences are **hourly**, **daily, weekly** or **monthly**.

### Example

```
#
# Set backup=hourly|daily|weekly|monthly to control frequency of
# backup attempts. (Use backup policies for fine-grained control over
# when backups happen.)
#
backup=hourly
#
# Set report=hourly|daily|weekly|monthly to control frequency of
# email reports.  (Hourly is probably a bit much!)  Only effective
# if email is not "".
#
report=daily
#
# Set email=ADDRESS to have the report emailed to that address.
#
email=root
#
# Set prune=hourly|daily|weekly|monthly|never to control frequency of
# automated pruning of old backups
#
prune=daily
#
# Set prune_incomplete=hourly|daily|weekly|monthly|never to control
# frequency of automated pruning of incomplete backups
#
prune_incomplete=weekly
#
# Prefix to the rsbackup command
# Use 'nice' and/or 'ionice' here.  Remember to quote correctly.
#
nicely=
```

## SEE ALSO

[**rsbackup**(1)](/rsbackup/1.md), [**rsbackup-mount**(1)](/rsbackup-mount/1.md), [**rsbackup**(5)](/rsbackup/5.md).

## AUTHOR

Richard Kettlewell \<rjk@greenend.org.uk\>