.\" Automatically generated by Pandoc 3.10.2
.\"
.TH "bup" "1" "2026\-09\-01" "Bup 0.34+"
.SH NAME
bup \- Backup program using rolling checksums and git file formats
.SH SYNOPSIS
bup [global options\&...]
<command> [options\&...]
.SH DESCRIPTION
\f[CR]bup\f[R] is a program for making backups of your files using the
git file format.
.PP
Unlike \f[CR]git\f[R](1) itself, bup is optimized for handling huge data
sets including individual very large files (such a virtual machine
images).
However, once a backup set is created, it can still be accessed using
git tools.
.PP
Subcommands are described in separate man pages.
For example \f[CR]bup\-init\f[R](1) covers \f[CR]bup init\f[R].
.SH GLOBAL OPTIONS
.TP
\-\-version
print bup\(cqs version number.
Equivalent to \f[CR]bup version\f[R].
.TP
\-d, \-\-bup\-dir=\f[I]BUP_DIR\f[R]
use the given BUP_DIR parameter as the bup repository location, instead
of reading it from the $BUP_DIR environment variable or using the
default \f[CR]\(ti/.bup\f[R] location.
.SH PRIMARY COMMANDS
.TP
\f[CR]bup\-init\f[R](1)
Initialize a bup repository
.TP
\f[CR]bup\-index\f[R](1)
Create or display the index of files to back up
.TP
\f[CR]bup\-save\f[R](1)
Save files into a backup set (note: run \(lqbup index\(rq first)
.TP
\f[CR]bup\-restore\f[R](1)
Extract files from a backup set
.TP
\f[CR]bup\-fsck\f[R](1)
Check backup sets for damage and add recovery information
.TP
\f[CR]bup\-on\f[R](1)
Index/save/split/get/\&...
a remote machine
.TP
\f[CR]bup\-help\f[R](1)
Print detailed help for the given command
.SH INSPECTION COMMANDS
.TP
\f[CR]bup\-ls\f[R](1)
Browse the files in your backup sets
.TP
\f[CR]bup\-fuse\f[R](1)
Mount your backup sets as a filesystem
.TP
\f[CR]bup\-web\f[R](1)
Launch a web server to examine backup sets
.TP
\f[CR]bup\-ftp\f[R](1)
Browse backup sets using an ftp\-like client
.SH MANIPULATION COMMANDS
.TP
\f[CR]bup\-gc\f[R](1)
Remove unreferenced, unneeded data
.TP
\f[CR]bup\-get\f[R](1)
Transfer/transform items between/within repositories
.TP
\f[CR]bup\-prune\-older\f[R](1)
Remove older saves
.TP
\f[CR]bup\-rm\f[R](1)
Remove references to archive content
.SH IMPORT COMMANDS
.TP
\f[CR]bup\-import\-duplicity\f[R](1)
Import from \f[CR]duplicity\f[R](1)
.TP
\f[CR]bup\-import\-rdiff\-backup\f[R](1)
Import from \f[CR]rdiff\-backup\f[R](1)
.TP
\f[CR]bup\-import\-rsnapshot\f[R](1)
Import from \f[CR]rsnapshot\f[R](1)
.SH OTHER COMMANDS
.TP
\f[CR]bup\-cat\-file\f[R](1)
Extract archive content
.TP
\f[CR]bup\-drecurse\f[R](1)
Recursively list files in your filesystem
.TP
\f[CR]bup\-features\f[R](1)
Report the current status and capabilities of bup itself
.TP
\f[CR]bup\-join\f[R](1)
Retrieve a file backed up using \f[CR]bup\-split\f[R](1)
.TP
\f[CR]bup\-server\f[R](1)
The server side of the bup client\-server relationship
.TP
\f[CR]bup\-split\f[R](1)
Split a single file into its own backup set
.TP
\f[CR]bup\-tag\f[R](1)
Tag a commit in the bup repository
.TP
\f[CR]bup\-validate\-object\-links\f[R](1)
Scan the repository for broken object links
.TP
\f[CR]bup\-validate\-ref\-links\f[R](1)
Check repository refs for links to missing objects
.TP
\f[CR]bup\-version\f[R](1)
Report the version number of your copy of bup.
.SH ESOTERIC COMMANDS
.TP
\f[CR]bup\-bloom\f[R](1)
Generates, regenerates, updates bloom filters
.TP
\f[CR]bup\-damage\f[R](1)
Deliberately destroy data
.TP
\f[CR]bup\-margin\f[R](1)
Determine how close your bup repository is to armageddon
.TP
\f[CR]bup\-memtest\f[R](1)
Test bup memory usage statistics
.TP
\f[CR]bup\-meta\f[R](1)
Create or extract a metadata archive
.TP
\f[CR]bup\-midx\f[R](1)
Index objects to speed up future backups
.TP
\f[CR]bup\-random\f[R](1)
Generate a stream of random output
.TP
\f[CR]bup\-tick\f[R](1)
Wait for up to one second.
.SH REMOTE OPTIONS
Some options (currently just \f[CR]\-\-remote\f[R]) allow the
specification of a remote path as either a URL (see
\f[CR]REPOSITORY URLS\f[R] below) or a
\f[CR][*user*\(at]*host*:[*path*]\f[R].
.PP
For either format, when there is no path, the default path on the server
will be used (\f[CR]BUP_DIR\f[R] if set in the remote environment or
\f[CR]\(ti/.bup\f[R]), and SSH settings for the connection can be
provided by a custom host in your \f[CR]\(ti/.ssh/config\f[R] file
(\f[CR]ssh_config(5)\f[R]).
.PP
The argument is treated as a URL if it begins with a syntactically valid
URL scheme prefix that contains an \(lqauthority\(rq (meaning that it
begins with \f[CR]SCHEME://\f[R] as \f[CR]ssh://...\f[R] does), and the
scheme must be either \f[CR]ssh\f[R] or \f[CR]bup\f[R]; others will be
rejected.
.PP
For the \f[CR][*user*\(at]*host*:[*path*]\f[R] syntax, if there is an
\(at symbol, then everything before the rightmost \(at is included in
the \f[I]user\f[R] so \f[CR]\-r x\(aty\(atz\f[R] indicates user
\f[CR]x\(aty\f[R], host \f[CR]z\f[R].
The \f[I]host\f[R] must always be followed by a colon, and anything
after the first colon is the \f[I]path\f[R].
.PP
For fully general purposes, prefer URLs to
\f[CR][*user*\(at]*host*:[*path*]\f[R], so that there is no potential
ambiguity.
For example, consider the (unlikely) case where \f[CR]ssh://x/y\f[R] is
generated for a host named \f[CR]ssh\f[R] and path \f[CR]//x/y\f[R],
which would be interpreted as a URL with host \f[CR]x\f[R] and path
\f[CR]/y\f[R].
.SH REPOSITORY URLS
Bup supports the following URL schemes (i.e.\ \f[CR]scheme:\f[R]) for
referring to a repository.
Note that the term \(lqauthority\(rq below just means the URL section
after the \f[CR]scheme://\f[R] and before the path, for example the
\(lquser\(athost:port\(rq of an SSH URL.
.PP
As an exception to the standard, a scheme may be \(lqpath\-oriented\(rq,
which means that there is no separate query or fragment.
Anything after the (optional) authority is taken as the \(lqpath\(rq and
the constituent bytes are not decoded (e.g.\ percent decoded).
This allows URLs provided on the command line to work naturally.
So \f[CR]ssh://host/x?z\f[R] has a path of \f[CR]/x?z\f[R].
.PP
And since URLs with an authority cannot represent relative paths,
path\-oriented schemes interpret a leading \f[CR]/./\f[R] as a relative
path.
So \f[CR]ssh://host/./x\f[R], \f[CR]file:///./x\f[R], and
\f[CR]file:/./x\f[R] all indicate the path \f[CR]x\f[R].
.TP
\f[CR]ssh:\f[R]
A path\-oriented scheme (see above) that specifies access to a
repository via a \f[CR]bup\-server(1)\f[R] launched on a host via SSH.
This scheme has syntax and semantics matching a typical \f[CR]ssh:\f[R]
URL, including support for a user and port
(e.g.\ \f[CR]ssh://user\(athost:2222/some/repo\f[R]), and the user and
host can be percent encoded.
.TP
\f[CR]bup:\f[R]
A path\-oriented scheme (see above) specifying a direct network
connection to to an existing \f[CR]bup\-server(1)\f[R].
Otherwise identical to \f[CR]ssh:\f[R], except that it does not support
a user.
This connection has no authentication or encryption of its own so
it\(cqs unlikely you\(cqll want to use it; prefer \f[CR]file:\f[R] or
\f[CR]:ssh:\f[R].
.TP
\f[CR]file:\f[R]
A path\-oriented scheme (see above) that specifies a repository\(cqs
filesystem path.
This scheme has syntax and semantics matching a typical \f[CR]file:\f[R]
URL, except that it only allows an empty authority (i.e.\ no user, host,
etc.).
.RS
In most cases, you will probably want to include the empty authority so
you don\(cqt have to consider the contents of the path carefully,
i.e.\ use \f[CR]file://PATH\f[R] or \f[CR]ssh://user\(athostPATH\f[R]
when the \f[CR]PATH\f[R] begins with a slash, and
\f[CR]file:///./PATH\f[R] or \f[CR]ssh://user\(athost/./PATH\f[R] when
it doesn\(cqt.
It is possible to omit the authority, but only if the path does not
begin with two slashes.
For example \f[CR]file:/\f[R] and \f[CR]file:some/where\f[R] are fine,
but \f[CR]file://some/where\f[R] is not because \f[CR]some\f[R] will be
read as the authority.
.RE
.SH ENVIRONMENT
.TP
\f[CR]BUP_ASSUME_GIT_VERSION_IS_FINE\f[R]
If set to \f[CR]true\f[R], \f[CR]yes\f[R], or \f[CR]1\f[R], assume the
version of \f[CR]git\f[R] in the path is acceptable.
.SH SEE ALSO
The \f[I]README\f[R] file from the bup distribution, \f[CR]git\f[R](1),
and http://bup.github.io
.SH AUTHORS
Avery Pennarun \c
.MT apenwarr@gmail.com
.ME \c.