Documentation/bup-save.md: change --strip-prefix to --strip-path.

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

diff --git a/Documentation/bup-bloom.md b/Documentation/bup-bloom.md
index 01373bff13288a3102e3784825f52aa2a2cd3f2f..ef7c3a3436401ad20eb63c5bff2007c38c8fb7b7 100644 (file)
--- a/Documentation/bup-bloom.md
+++ b/Documentation/bup-bloom.md
@@ -8,19 +8,29 @@ 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] [-f] [--ruin]
 
 # DESCRIPTION
 
-`bup bloom` builds a bloom filter file for a bup repo, if
-one already exists, it checks it and updates or regenerates
-it if needed.
+`bup bloom` builds a bloom filter file for a bup
+repository. If one already exists, it checks the filter and
+updates or regenerates it as needed.
 
 # OPTIONS
 
+--ruin
+:   destroy bloom filters by setting the whole bitmask to
+    zeros.  you really want to know what you are doing if
+    run this and you want to delete the resulting bloom
+    when you are done with it.
+
+-f, --force
+:   don't update the existing bloom file; generate a new
+    one from scratch.
+
 -d, --dir=*directory*
 :   the directory, containing .idx files, to process.
-    defaults to $BUP_DIR/objects/pack
+    Defaults to $BUP_DIR/objects/pack
 
 -o, --outfile=*outfile*
 :   the file to write the bloom filter to.  defaults to
@@ -28,8 +38,16 @@ it if needed.
 
 -k, --hashes=*hashes*
 :   number of hash functions to use only 4 and 5 are valid.
-    defaults to 5 for repositories < 2TiB and 4 otherwise.
-    see comments in git.py for more on this value.
+    defaults to 5 for repositories < 2 TiB, or 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