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

# rsbackup-snapshot-hook(1)

rsync-based backup utility

## NAME

rsbackup-snapshot-hook - rsync-based backup utility

## SYNOPSIS

**rsbackup-snapshot-hook** \[*OPTIONS*\]

## DESCRIPTION

**rsbackup-snapshot-hook** creates and removes LVM snapshots when configured as a pre- or post-volume-hook for [**rsbackup**(1)](/rsbackup/1.md).

Snapshots will only be created for volumes that have a corresponding directory in the snapshot directory. For instance, a snapshot will be created for the volume **root** if */var/lib/rsbackup/snapshots/root* exists. (Use the **--snaps** option to change the snapshot directory.) Such volumes must be stored in a logical volume.

Leftover snapshots are always unmounted and removed before creation.

Snapshots are given only a fraction of the size of the original volume. Use the **--divisor** to change this.

After creation snapshots are fsck'd and mounted. If an error occurs in any part of the creation process, the partially snapshot created snapshot may be left in place (and ultimately be torn down when the post-volume-hook is run).

## OPTIONS

- **--snaps, -s *PATH***

  Set the path to the snapshot directory. The default is */var/lib/rsbackup/snapshots*.

- **--divisor, -d *DIVISOR***

  Set the snapshot size ratio. The default is 5.

- **--help, -h**

  Display usage message.

- **--version, -V**

  Display version string.

## SEE ALSO

[**rsbackup**(1)](/rsbackup/1.md), [**lvm**(8)](/lvm/8.md)

## AUTHOR

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