Update base_version to 0.34~ for 0.34 development

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

diff --git a/Documentation/bup-margin.md b/Documentation/bup-margin.md
index 042c1825ff954c4c671f1b4fb29e960fc18d6a59..9412ad62a86a8724c1c755a6d99c7ad363679675 100644 (file)
--- a/Documentation/bup-margin.md
+++ b/Documentation/bup-margin.md
@@ -8,7 +8,7 @@ bup-margin - figure out your deduplication safety margin
 
 # SYNOPSIS
 
-bup margin
+bup margin [options...]
 
 # DESCRIPTION
 
@@ -37,11 +37,37 @@ collisions, you can monitor your repository by running `bup
 margin` occasionally to see if you're getting dangerously
 close to 160 bits.
 
-# EXAMPLE
+# OPTIONS
 
+\--predict
+:   Guess the offset into each index file where a
+    particular object will appear, and report the maximum
+    deviation of the correct answer from the guess.  This
+    is potentially useful for tuning an interpolation
+    search algorithm.
+    
+\--ignore-midx
+:   don't use `.midx` files, use only `.idx` files.  This is
+    only really useful when used with `--predict`.
+
+    
+# EXAMPLES
     $ bup margin
-    Reading indexes: 100.00% (11188299/11188299), done.
-    45
+    Reading indexes: 100.00% (1612581/1612581), done.
+    40
+    40 matching prefix bits
+    1.94 bits per doubling
+    120 bits (61.86 doublings) remaining
+    4.19338e+18 times larger is possible
+    
+    Everyone on earth could have 625878182 data sets
+    like yours, all in one repository, and we would
+    expect 1 object collision.
+    
+    $ bup margin --predict
+    PackIdxList: using 1 index.
+    Reading indexes: 100.00% (1612581/1612581), done.
+    915 of 1612581 (0.057%) 
     
 
 # SEE ALSO