Documentation/bup-bloom.md

   1 % bup-bloom(1) Bup %BUP_VERSION%
   2 % Brandon Low <lostlogic@lostlogicx.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-bloom - generates, regenerates, updates bloom filters
   8
   9 # SYNOPSIS
  10
  11 bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile]
  12
  13 # DESCRIPTION
  14
  15 `bup bloom` builds a bloom filter file for a bup repo, if
  16 one already exists, it checks it and updates or regenerates
  17 it if needed.
  18
  19 # OPTIONS
  20
  21 -d, --dir=*directory*
  22 :   the directory, containing .idx files, to process.
  23     defaults to $BUP_DIR/objects/pack
  24
  25 -o, --outfile=*outfile*
  26 :   the file to write the bloom filter to.  defaults to
  27     $dir/bup.bloom
  28
  29 -k, --hashes=*hashes*
  30 :   number of hash functions to use only 4 and 5 are valid.
  31     defaults to 5 for repositories < 2TiB and 4 otherwise.
  32     see comments in git.py for more on this value.
  33
  34 -c, --check=*idxfile*
  35 :   checks the bloom file (counterintuitively outfile)
  36     against the specified .idx file, first checks that the
  37     bloom filter is claiming to contain the .idx, then
  38     checks that it does actually contain all of the objects
  39     in the .idx.  Does not write anything and ignores the
  40     `-k` option.
  41
  42 # BUP
  43
  44 Part of the `bup`(1) suite.