Documentation/bup.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 [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 The individual bup subcommands appear in their own man
  25 pages.
  26
  27 # GLOBAL OPTIONS
  28
  29 \--version
  30 :   print bup's version number.  Equivalent to
  31     `bup-version`(1)
  32
  33 -d, \--bup-dir=*BUP_DIR*
  34 :   use the given BUP_DIR parameter as the bup repository
  35     location, instead of reading it from the $BUP_DIR
  36     environment variable or using the default `~/.bup`
  37     location.
  38
  39
  40 # COMMONLY USED SUBCOMMANDS
  41
  42 `bup-fsck`(1)
  43 :   Check backup sets for damage and add redundancy information
  44 `bup-ftp`(1)
  45 :   Browse backup sets using an ftp-like client
  46 `bup-fuse`(1)
  47 :   Mount your backup sets as a filesystem
  48 `bup-help`(1)
  49 :   Print detailed help for the given command
  50 `bup-index`(1)
  51 :   Create or display the index of files to back up
  52 `bup-on`(1)
  53 :   Backup a remote machine to the local one
  54 `bup-restore`(1)
  55 :   Extract files from a backup set
  56 `bup-save`(1)
  57 :   Save files into a backup set (note: run "bup index" first)
  58 `bup-web`(1)
  59 :   Launch a web server to examine backup sets
  60
  61
  62 # RARELY USED SUBCOMMANDS
  63
  64 `bup-damage`(1)
  65 :   Deliberately destroy data
  66 `bup-drecurse`(1)
  67 :   Recursively list files in your filesystem
  68 `bup-init`(1)
  69 :   Initialize a bup repository
  70 `bup-join`(1)
  71 :   Retrieve a file backed up using `bup-split`(1)
  72 `bup-ls`(1)
  73 :   Browse the files in your backup sets
  74 `bup-margin`(1)
  75 :   Determine how close your bup repository is to armageddon
  76 `bup-memtest`(1)
  77 :   Test bup memory usage statistics
  78 `bup-midx`(1)
  79 :   Index objects to speed up future backups
  80 `bup-newliner`(1)
  81 :   Make sure progress messages don't overlap with output
  82 `bup-random`(1)
  83 :   Generate a stream of random output
  84 `bup-server`(1)
  85 :   The server side of the bup client-server relationship
  86 `bup-split`(1)
  87 :   Split a single file into its own backup set
  88 `bup-tick`(1)
  89 :   Wait for up to one second.
  90 `bup-version`(1)
  91 :   Report the version number of your copy of bup.
  92
  93
  94 # SEE ALSO
  95
  96 `git`(1) and the *README* file from the bup distribution.
  97
  98 The home of bup is at <http://github.com/bup/bup/>.