| 1 |
% bup(1) Bup %BUP_VERSION% |
| 2 |
% Avery Pennarun <[email protected]> |
| 3 |
% %BUP_DATE% |
| 4 |
|
| 5 |
# NAME |
| 6 |
|
| 7 |
bup - Backup program using rolling checksums and git file formats |
| 8 |
|
| 9 |
# SYNOPSIS |
| 10 |
|
| 11 |
bup [global options...] \<command\> [options...] |
| 12 |
|
| 13 |
# DESCRIPTION |
| 14 |
|
| 15 |
`bup` is a program for making backups of your files using |
| 16 |
the git file format. |
| 17 |
|
| 18 |
Unlike `git`(1) itself, bup is |
| 19 |
optimized for handling huge data sets including individual |
| 20 |
very large files (such a virtual machine images). However, |
| 21 |
once a backup set is created, it can still be accessed |
| 22 |
using git tools. |
| 23 |
|
| 24 |
Subcommands are described in separate man pages. For example |
| 25 |
`bup-init`(1) covers `bup init`. |
| 26 |
|
| 27 |
# GLOBAL OPTIONS |
| 28 |
|
| 29 |
\--version |
| 30 |
: print bup's version number. Equivalent to `bup version`. |
| 31 |
|
| 32 |
-d, \--bup-dir=*BUP_DIR* |
| 33 |
: use the given BUP_DIR parameter as the bup repository |
| 34 |
location, instead of reading it from the $BUP_DIR |
| 35 |
environment variable or using the default `~/.bup` |
| 36 |
location. |
| 37 |
|
| 38 |
|
| 39 |
# COMMONLY USED SUBCOMMANDS |
| 40 |
|
| 41 |
`bup-fsck`(1) |
| 42 |
: Check backup sets for damage and add redundancy information |
| 43 |
|
| 44 |
`bup-ftp`(1) |
| 45 |
: Browse backup sets using an ftp-like client |
| 46 |
|
| 47 |
`bup-fuse`(1) |
| 48 |
: Mount your backup sets as a filesystem |
| 49 |
|
| 50 |
`bup-help`(1) |
| 51 |
: Print detailed help for the given command |
| 52 |
|
| 53 |
`bup-index`(1) |
| 54 |
: Create or display the index of files to back up |
| 55 |
|
| 56 |
`bup-on`(1) |
| 57 |
: Backup a remote machine to the local one |
| 58 |
|
| 59 |
`bup-restore`(1) |
| 60 |
: Extract files from a backup set |
| 61 |
|
| 62 |
`bup-save`(1) |
| 63 |
: Save files into a backup set (note: run "bup index" first) |
| 64 |
|
| 65 |
`bup-web`(1) |
| 66 |
: Launch a web server to examine backup sets |
| 67 |
|
| 68 |
|
| 69 |
# RARELY USED SUBCOMMANDS |
| 70 |
|
| 71 |
`bup-damage`(1) |
| 72 |
: Deliberately destroy data |
| 73 |
|
| 74 |
`bup-drecurse`(1) |
| 75 |
: Recursively list files in your filesystem |
| 76 |
|
| 77 |
`bup-init`(1) |
| 78 |
: Initialize a bup repository |
| 79 |
|
| 80 |
`bup-join`(1) |
| 81 |
: Retrieve a file backed up using `bup-split`(1) |
| 82 |
|
| 83 |
`bup-ls`(1) |
| 84 |
: Browse the files in your backup sets |
| 85 |
|
| 86 |
`bup-margin`(1) |
| 87 |
: Determine how close your bup repository is to armageddon |
| 88 |
|
| 89 |
`bup-memtest`(1) |
| 90 |
: Test bup memory usage statistics |
| 91 |
|
| 92 |
`bup-midx`(1) |
| 93 |
: Index objects to speed up future backups |
| 94 |
|
| 95 |
`bup-newliner`(1) |
| 96 |
: Make sure progress messages don't overlap with output |
| 97 |
|
| 98 |
`bup-random`(1) |
| 99 |
: Generate a stream of random output |
| 100 |
|
| 101 |
`bup-server`(1) |
| 102 |
: The server side of the bup client-server relationship |
| 103 |
|
| 104 |
`bup-split`(1) |
| 105 |
: Split a single file into its own backup set |
| 106 |
|
| 107 |
`bup-tick`(1) |
| 108 |
: Wait for up to one second. |
| 109 |
|
| 110 |
`bup-version`(1) |
| 111 |
: Report the version number of your copy of bup. |
| 112 |
|
| 113 |
|
| 114 |
# ENVIRONMENT |
| 115 |
|
| 116 |
`BUP_ASSUME_GIT_VERSION_IS_FINE` |
| 117 |
: If set to `true`, `yes`, or `1`, assume the version of `git` |
| 118 |
in the path is acceptable. |
| 119 |
|
| 120 |
|
| 121 |
# SEE ALSO |
| 122 |
|
| 123 |
`git`(1) and the *README* file from the bup distribution. |
| 124 |
|
| 125 |
The home of bup is at <http://github.com/bup/bup/>. |