Add a --check behavior to verify bloom

[bup.git] / Documentation / bup-bloom.md

diff --git a/Documentation/bup-bloom.md b/Documentation/bup-bloom.md
index 01373bff13288a3102e3784825f52aa2a2cd3f2f..1501e2e0c517959afdc03ce39830157eb10f3f68 100644 (file)
--- a/Documentation/bup-bloom.md
+++ b/Documentation/bup-bloom.md
@@ -8,7 +8,7 @@ bup-bloom - generates, regenerates, updates bloom filters
 
 # SYNOPSIS
 
-bup daemon [-d dir] [-o outfile] [-k hashes]
+bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile]
 
 # DESCRIPTION
 
@@ -31,6 +31,14 @@ it if needed.
     defaults to 5 for repositories < 2TiB and 4 otherwise.
     see comments in git.py for more on this value.
 
+-c, --check=*idxfile*
+:   checks the bloom file (counterintuitively outfile)
+    against the specified .idx file, first checks that the
+    bloom filter is claiming to contain the .idx, then
+    checks that it does actually contain all of the objects
+    in the .idx.  Does not write anything and ignores the
+    `-k` option.
+
 # BUP
 
 Part of the `bup`(1) suite.