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 (CAUTION: EXPERIMENTAL)
   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 the forthcoming `bup gc`
  22 command, or by a normal `git gc`, may permanently delete data that is
  23 no longer reachable from the remaining branches or tags, and reclaim
  24 the related storage space.
  25
  26 NOTE: This is one of the few bup commands that modifies your archive
  27 in intentionally destructive ways.
  28
  29 # OPTIONS
  30
  31 -v, \--verbose
  32 :   increase verbosity (can be used more than once).
  33
  34 -*#*, \--compress=*#*
  35 :   set the compression level to # (a value from 0-9, where
  36     9 is the highest and 0 is no compression).  The default
  37     is 6.  Note that `bup rm` may only write new commits.
  38
  39 # EXAMPLES
  40
  41     # Delete the backup set (branch) foo and a save in bar.
  42     $ bup rm /foo /bar/2014-10-21-214720
  43
  44 # SEE ALSO
  45
  46 `bup-save`(1), `bup-fsck`(1), and `bup-tag`(1)
  47
  48 # BUP
  49
  50 Part of the `bup`(1) suite.