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
  45 `bup-ftp`(1)
  46 :   Browse backup sets using an ftp-like client
  47
  48 `bup-fuse`(1)
  49 :   Mount your backup sets as a filesystem
  50
  51 `bup-help`(1)
  52 :   Print detailed help for the given command
  53
  54 `bup-index`(1)
  55 :   Create or display the index of files to back up
  56
  57 `bup-on`(1)
  58 :   Backup a remote machine to the local one
  59
  60 `bup-restore`(1)
  61 :   Extract files from a backup set
  62
  63 `bup-save`(1)
  64 :   Save files into a backup set (note: run "bup index" first)
  65
  66 `bup-web`(1)
  67 :   Launch a web server to examine backup sets
  68
  69
  70 # RARELY USED SUBCOMMANDS
  71
  72 `bup-damage`(1)
  73 :   Deliberately destroy data
  74
  75 `bup-drecurse`(1)
  76 :   Recursively list files in your filesystem
  77
  78 `bup-init`(1)
  79 :   Initialize a bup repository
  80
  81 `bup-join`(1)
  82 :   Retrieve a file backed up using `bup-split`(1)
  83
  84 `bup-ls`(1)
  85 :   Browse the files in your backup sets
  86
  87 `bup-margin`(1)
  88 :   Determine how close your bup repository is to armageddon
  89
  90 `bup-memtest`(1)
  91 :   Test bup memory usage statistics
  92
  93 `bup-midx`(1)
  94 :   Index objects to speed up future backups
  95
  96 `bup-newliner`(1)
  97 :   Make sure progress messages don't overlap with output
  98
  99 `bup-random`(1)
 100 :   Generate a stream of random output
 101
 102 `bup-server`(1)
 103 :   The server side of the bup client-server relationship
 104
 105 `bup-split`(1)
 106 :   Split a single file into its own backup set
 107
 108 `bup-tick`(1)
 109 :   Wait for up to one second.
 110
 111 `bup-version`(1)
 112 :   Report the version number of your copy of bup.
 113
 114
 115 # SEE ALSO
 116
 117 `git`(1) and the *README* file from the bup distribution.
 118
 119 The home of bup is at <http://github.com/bup/bup/>.