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 # COMMONLY USED SUBCOMMANDS
  40
  41 `bup-fsck`(1)
  42 :   Check backup sets for damage and add redundancy information
  43 `bup-ftp`(1)
  44 :   Browse backup sets using an ftp-like client
  45 `bup-fuse`(1)
  46 :   Mount your backup sets as a filesystem
  47 `bup-help`(1)
  48 :   Print detailed help for the given command
  49 `bup-index`(1)
  50 :   Create or display the index of files to back up
  51 `bup-midx`(1)
  52 :   Index objects to speed up future backups
  53 `bup-save`(1)
  54 :   Save files into a backup set (note: run "bup index" first)
  55 `bup-web`(1)
  56 :   Launch a web server to examine backup sets
  57
  58 # RARELY USED SUBCOMMANDS
  59
  60 `bup-damage`(1)
  61 :   Deliberately destroy data
  62 `bup-drecurse`(1)
  63 :   Recursively list files in your filesystem
  64 `bup-init`(1)
  65 :   Initialize a bup repository
  66 `bup-join`(1)
  67 :   Retrieve a file backed up using `bup-split`(1)
  68 `bup-ls`(1)
  69 :   Browse the files in your backup sets
  70 `bup-margin`(1)
  71 :   Determine how close your bup repository is to armageddon
  72 `bup-memtest`(1)
  73 :   Test bup memory usage statistics
  74 `bup-newliner`(1)
  75 :   Make sure progress messages don't overlap with output
  76 `bup-random`(1)
  77 :   Generate a stream of random output
  78 `bup-server`(1)
  79 :   The server side of the bup client-server relationship
  80 `bup-split`(1)
  81 :   Split a single file into its own backup set
  82 `bup-tick`(1)
  83 :   Wait for up to one second.
  84 `bup-version`(1)
  85 :   Report the version number of your copy of bup.
  86
  87 # SEE ALSO
  88
  89 `git`(1) and the *README* file from the bup distribution.
  90
  91 The home of bup is at <http://github.com/apenwarr/bup/>.