Add index option "--exclude-rx-from FILE".

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

diff --git a/Documentation/bup-memtest.md b/Documentation/bup-memtest.md
index 108a5a1328fe97f0df5fb771ab3c5af8632b0194..b7b467e23d3c03ae115a9eed528775aeacb24eed 100644 (file)
--- a/Documentation/bup-memtest.md
+++ b/Documentation/bup-memtest.md
@@ -28,20 +28,32 @@ what causes an increase in the VmRSS column.
 
 # OPTIONS
 
--n, --number=*number*
+-n, \--number=*number*
 :   set the number of objects to search for during each
     cycle (ie. before printing a line of output)
     
--c, --cycles=*cycles*
+-c, \--cycles=*cycles*
 :   set the number of cycles (ie. the number of lines of
     output after the first).  The first line of output is
     always 0 (ie. the baseline before searching for any
     objects).
     
---ignore-midx
+\--ignore-midx
 :   ignore any `.midx` files created by `bup midx`.  This
     allows you to compare memory performance with and
     without using midx.
+    
+\--existing
+:   search for existing objects instead of searching for
+    random nonexistent ones.  This can greatly affect
+    memory usage and performance.  Note that most of the
+    time, `bup save` spends most of its time searching for
+    nonexistent objects, since existing ones are probably
+    in unmodified files that we won't be trying to back up
+    anyway.  So the default behaviour reflects real bup
+    performance more accurately.  But you might want this
+    option anyway just to make sure you haven't made
+    searching for existing objects much worse than before.
 
 
 # EXAMPLE