Add documentation for import-rdiff-backup

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

diff --git a/Documentation/bup-midx.md b/Documentation/bup-midx.md
index 829a74a2e120404ca4133a23c461d3f0b4df6e9d..7c67a2dd0e20ac8503b0b9eff13d54392f7a2745 100644 (file)
--- a/Documentation/bup-midx.md
+++ b/Documentation/bup-midx.md
@@ -8,33 +8,51 @@ bup-midx - create a multi-index (.midx) file from several .idx files
 
 # SYNOPSIS
 
-bup midx [-o *outfile*] <-a|-f|*idxnames*...>
+bup midx [-o *outfile*] \<-a|-f|*idxnames*...\>
 
 # DESCRIPTION
 
 `bup midx` creates a multi-index (.midx) file from one or more
 git pack index (.idx) files.
 
-You should run this command
-occasionally to ensure your backups run quickly and without
-requiring too much RAM.
+Note: you should no longer need to run this command by hand. 
+It gets run automatically by `bup-save`(1) and similar
+commands.
 
 # OPTIONS
 
--o, --output
+-o, \--output=*filename.midx*
 :   use the given output filename for the .midx file. 
     Default is auto-generated.
     
--a, --auto
+-a, \--auto
 :   automatically generate new .midx files for any .idx
     files where it would be appropriate.
     
--f, --force
+-f, \--force
 :   force generation of a single new .midx file containing
     *all* your .idx files, even if other .midx files
     already exist.  This will result in the fastest backup
     performance, but may take a long time to run.
 
+\--dir=*packdir*
+:   specify the directory containing the .idx/.midx files
+    to work with.  The default is $BUP_DIR/objects/pack and
+    $BUP_DIR/indexcache/*.
+
+\--max-files
+:   maximum number of .idx files to open at a time.  You
+    can use this if you have an especially small number of file
+    descriptors available, so that midx can complete
+    (though possibly non-optimally) even if it can't open
+    all your .idx files at once.  The default value of this
+    option should be fine for most people.
+    
+\--check
+:   validate a .midx file by ensuring that all objects in
+    its contained .idx files exist inside the .midx.  May
+    be useful for debugging.
+
 
 # EXAMPLE
 
@@ -78,10 +96,6 @@ objects that *do* exist can be optimized; for example,
 consecutive objects are often stored in the same pack, so
 we can search that one first using an MRU algorithm.)
 
-With large repositories, you should be sure to run
-`bup midx -a` or `bup midx -f` every now and then so that
-creating backups will remain efficient.
-
 
 # SEE ALSO