Debian Codegraph @

Documentation/man5/man3/man2/man7/man2/man4/bup-bloom.1.md

raw
1 % bup-bloom(1) Bup %BUP_VERSION%
2 % Brandon Low <[email protected]>
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] [-f] [\--ruin]
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 \--ruin
22 : destroy bloom filters by setting the whole bitmask to
23 zeros. you really want to know what you are doing if
24 run this and you want to delete the resulting bloom
25 when you are done with it.
26
27 -f, \--force
28 : don't update the existing bloom file; generate a new
29 one from scratch.
30
31 -d, \--dir=*directory*
32 : the directory, containing `.idx` files, to process.
33 Defaults to $BUP_DIR/objects/pack
34
35 -o, \--outfile=*outfile*
36 : the file to write the bloom filter to. defaults to
37 $dir/bup.bloom
38
39 -k, \--hashes=*hashes*
40 : number of hash functions to use only 4 and 5 are valid.
41 defaults to 5 for repositories < 2 TiB, or 4 otherwise.
42 See comments in git.py for more on this value.
43
44 -c, \--check=*idxfile*
45 : checks the bloom file (counterintuitively outfile)
46 against the specified `.idx` file, first checks that the
47 bloom filter is claiming to contain the `.idx`, then
48 checks that it does actually contain all of the objects
49 in the `.idx`. Does not write anything and ignores the
50 `-k` option.
51
52 # BUP
53
54 Part of the `bup`(1) suite.