snap - a simple backup tool based on rsync
snap [option...] source archive
snap [option...] profile
When the second form is used,
snap reads its configuration from the file profile.conf, which must be stored in one of the configuration directories. See the PROFILES section for details.
snap you can create incremental snapshots of directory trees. Running
snap creates a full copy of source in archive/date-time, with date and time being the date and time of the moment when the snapshot was taken. The snapshots are completely transparent and can be explored and restored using normal file commands. To save time and disk space,
snap uses hard links to store files that have not changed between subsequent snapshots stored in the same archive.
snap, you must specify at least a source directory and an archive directory. Additionally, you can specify files and directories that are to be excluded from the backup. By default,
snap preserves symbolic links, permissions, modification times, and ownership information. Optionally, it can also preserve hard links, access control lists, and extended attributes.
snap uses rsync(1) for its operation.
Exclude files and directories matching pattern from the snapshot. See the section on exclude patterns in the rsync(1) manual for details on the pattern syntax.
Link to files in dir when they are unchanged. Before a file is copied,
snap tests whether one of the directories specified using this option contains a file with identical name, relative path, attributes, and contents. If it finds such a file,
snap creates a hard link to this file instead of an actual copy. This works only if dir is in the same file system as archive and if this file system supports hard links.
Without this option,
snap tries to link to the latest successful snapshot in the archive directory, unless you specify the
Create a full (non-incremental) copy of the source directory. With this option,
snap does not try to link to a previous snapshot in archive. It is still possible to create links using the
Compute checksums to find changed files. By default,
snap determines whether a file has changed since the last snapshot by comparing file sizes and modification times, which should be safe in normal cases. With this option,
snap computes a checksum for each file, which is safer, but significantly slows down the creation of a snapshot.
Preserve hard links in the backup. With this option,
snap hard-links files that are hard-linked in the source directory also in the archive directory. This option is disabled by default because finding hard-linked files can be an expensive operation. See the rsync(1) manual for details on this option.
Preserve access control lists in the backup. See the rsync(1) manual for details on this option.
Preserve extended attributes in the backup. See the rsync(1) manual for details on this option.
Print information about transferred files.
Ask for confirmation before creating the snapshot. This is the default when the complete configuration is specified on the command-line.
Do not ask for confirmation before creating the snapshot. This is the default when part of the configuration is read from a file.
Print version information and exit.
Show usage information and exit.
If you create regular snapshots, it is convenient to store the configuration in a file. Such a predefined configuration is called a profile and must be stored in a file with extension .conf.
snap searches for system-wide profiles in /etc/snap and for user profiles in $HOME/$XDG_USER_DIR/snap (which defaults to $HOME/.config/snap when XDG_USER_DIR is not set). A user profile takes precedence over a system-wide profile of the same name. The options specified in the profile are combined with the options specified on the command line.
Configuration files are read line-by-line. Empty lines and lines starting with
# are ignored. All other lines must contain one of the following elements:
Defines a source path. This element is equivalent to the source command-line argument.
Defines an archive path. This element is equivalent to the archive command-line argument.
Adds an exclude pattern. This element is equivalent to the
--exclude command-line option. Note that patterns must not be quoted in configuration files.
Adds a link directory. This element is equivalent to the
--link command-line option.
Sets some options. Each option is equivalent to the command-line option of the same name. The options must be separated by commas or spaces.
The case of the keywords left to the
= is not significant; additional spaces around keywords and values are ignored. A configuration file must contain exactly one
Source element and exactly one
Used to locate user profiles.
Used to locate user profiles. When XDG_USER_DIR is not set,
snap assumes its default value $HOME/.config.
snap searches for profiles in the following locations:
The location for system-wide profiles.
The location for user profiles. When XDG_USER_DIR is not set,
snap searches for user profiles in $HOME/.config/snap.
If source ends with a slash,
snap copies only the contents of the source directory, excluding the last part of the source path. Otherwise,
snap copies the source directory, including the last part of the source path.
The file system that contains the archive directory must support hard links for
snap to be able to store subsequent snapshots efficiently. Without hard links,
snap has to perform an actual copy of all files --- even the unmodified ones --- from the source directory. This can require much more time and disk space than on a file system which supports hard links.
snap preserves only those file attributes that are supported by the file system containing the archive directory. Therefore it is not a good idea to make a backup of an Ext4 file system on a FAT-formatted USB disk (but using FAT is not a good idea anyway).
Although rsync(1) is able to copy directly between remote locations, the current version of
snap requires source and archive to be mounted directories.
The following command creates a snapshot of the home directory of user alice in /mnt/backup/alice. Files in .cache, .thumbnails, and the Firefox and Thunderbird caches are excluded from the backup; extended file attributes as well as ACLs are preserved:
snap --exclude="/.cache/" \ --exclude="/.thumbnails/" \ --exclude="/.mozilla/firefox/*/Cache/" \ --exclude="/.thunderbird/*/Cache/" \ --xattrs --acls \ /home/alice \ /mnt/backup/alice
To store this setup in a profile, create a file alice.conf which contains the following lines:
Source = /home/alice Archive = /mnt/backup/alice Exclude = /.cache/ Exclude = /.thumbnails/ Exclude = /.mozilla/firefox/*/Cache/ Exclude = /.thunderbird/*/Cache/ Options = xattrs acls
Copy this file to /home/alice/.config/snap (if you are user alice) or to /etc/snap (if you are the system administrator). The following command then creates a backup using the profile alice: