Documentation/bup.1.md

   1 % bup(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup - Backup program using rolling checksums and git file formats
   8
   9 # SYNOPSIS
  10
  11 bup <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 The individual bup subcommands appear in their own man
  25 pages.
  26
  27 # COMMONLY USED SUBCOMMANDS
  28
  29 `bup-index`(1)
  30 :   Manage the index of files to back up.
  31 `bup-fsck`(1)
  32 :   Verify or recover the bup repository.
  33 `bup-fuse`(1)
  34 :   Mount the bup repository as a filesystem.
  35 `bup-save`(1)
  36 :   Back up the files in the index.
  37 `bup-split`(1)
  38 :   Back up an individual file, such as a tarball.
  39 `bup-join`(1)
  40 :   Retrieve a file backed up using `bup-split`(1).
  41 `bup-midx`(1)
  42 :   Make backups go faster by generating midx files.
  43
  44 # RARELY USED SUBCOMMANDS
  45
  46 `bup-damage`(1)
  47 :   Deliberately destroy data.
  48 `bup-drecurse`(1)
  49 :   Recursively list files in your filesystem.
  50 `bup-init`(1)
  51 :   Initialize a bup repository.
  52 `bup-ls`(1)
  53 :   List the files in a bup repository.
  54 `bup-margin`(1)
  55 :   Determine how close your bup repository is to armageddon.
  56 `bup-server`(1)
  57 :   The server side of the bup client-server relationship.
  58 `bup-tick`(1)
  59 :   Sleep for up to one second.
  60
  61 # SEE ALSO
  62
  63 `git`(1) and the *README* file from the bup distribution.
  64
  65 The home of bup is at <http://github.com/apenwarr/bup/>.