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 daemon [-d dir] [-o outfile] [-k hashes]
  12
  13 # DESCRIPTION
  14
  15 `bup bloom` builds a bloom filter file for a bup
  16 repository. If one already exists, it checks the filter and
  17 updates or regenerates it as needed.
  18
  19 # OPTIONS
  20
  21 -f, --force
  22 :   don't update the existing bloom file; generate a new
  23     one from scratch.
  24
  25 -d, --dir=*directory*
  26 :   the directory, containing .idx files, to process.
  27     Defaults to $BUP_DIR/objects/pack
  28
  29 -o, --outfile=*outfile*
  30 :   the file to write the bloom filter to.  defaults to
  31     $dir/bup.bloom
  32
  33 -k, --hashes=*hashes*
  34 :   number of hash functions to use only 4 and 5 are valid.
  35     defaults to 5 for repositories < 2 TiB, or 4 otherwise.
  36     See comments in git.py for more on this value.
  37
  38 # BUP
  39
  40 Part of the `bup`(1) suite.