Documentation/bup-rm.md

   1 % bup-rm(1) Bup %BUP_VERSION%
   2 % Rob Browning <rlb@defaultvalue.org>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-rm - remove references to archive content
   8
   9 # SYNOPSIS
  10
  11 bup rm [-#|\--verbose] <*branch*|*save*...>
  12
  13 # DESCRIPTION
  14
  15 `bup rm` removes the indicated *branch*es (backup sets) and *save*s.
  16 By itself, this command does not delete any actual data (nor recover
  17 any storage space), but it may make it very difficult or impossible to
  18 refer to the deleted items, unless there are other references to them
  19 (e.g. tags).
  20
  21 A subsequent garbage collection, either by a `bup gc`, or by a normal
  22 `git gc`, may permanently delete data that is no longer reachable from
  23 the remaining branches or tags, and reclaim the related storage space.
  24
  25 WARNING: This is one of the few bup commands that modifies your
  26 archive in intentionally destructive ways.
  27
  28 # OPTIONS
  29
  30 -v, \--verbose
  31 :   increase verbosity (can be used more than once).
  32
  33 -*#*, \--compress=*#*
  34 :   set the compression level to # (a value from 0-9, where
  35     9 is the highest and 0 is no compression).  The default
  36     is 6.  Note that `bup rm` may only write new commits.
  37
  38 # EXAMPLES
  39
  40     # Delete the backup set (branch) foo and a save in bar.
  41     $ bup rm /foo /bar/2014-10-21-214720
  42
  43 # SEE ALSO
  44
  45 `bup-gc`(1), `bup-save`(1), `bup-fsck`(1), and `bup-tag`(1)
  46
  47 # BUP
  48
  49 Part of the `bup`(1) suite.