Documentation: Protect file extensions from start of line.

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

diff --git a/Documentation/bup-index.md b/Documentation/bup-index.md
index 4e43f599e5b59bf88dd8db1cdde4271d7a687d9e..959177789f6e8271f270bc28754ff41fe41f33cd 100644 (file)
--- a/Documentation/bup-index.md
+++ b/Documentation/bup-index.md
@@ -8,8 +8,9 @@ bup-index - print and/or update the bup filesystem index
 
 # SYNOPSIS
 
-bup index <-p|-m|-u> [-s] [-H] [-l] [-x] [--fake-valid]
-[--check] [-f *indexfile*] [-v] <filenames...>
+bup index \<-p|-m|-s|-u\> [-H] [-l] [-x] [\--fake-valid]
+[\--fake-invalid] [\--check] [-f *indexfile*] [\--exclude *path*]
+[\--exclude-from *filename*] [-v] \<filenames...\>
 
 # DESCRIPTION
 
@@ -39,31 +40,35 @@ other purposes (such as speeding up other programs that
 need the same information).
 
 
-# OPTIONS
+# MODES
 
--u, --update
-:   (recursively) update the index for the given filenames and
+-u, \--update
+:   recursively update the index for the given filenames and
     their descendants.  One or more filenames must be
-    given.
+    given.  If no mode option is given, this is the
+    default.
 
--p, --print
+-p, \--print
 :   print the contents of the index.  If filenames are
     given, shows the given entries and their descendants. 
     If no filenames are given, shows the entries starting
     at the current working directory (.).
     
--m, --modified
+-m, \--modified
 :   prints only files which are marked as modified (ie.
     changed since the most recent backup) in the index. 
     Implies `-p`.
 
--s, --status
+-s, \--status
 :   prepend a status code (A, M, D, or space) before each
     filename.  Implies `-p`.  The codes mean, respectively,
     that a file is marked in the index as added, modified,
     deleted, or unchanged since the last backup.
     
--H, --hash
+
+# OPTIONS
+
+-H, \--hash
 :   for each file printed, prepend the most recently
     recorded hash code.  The hash code is normally
     generated by `bup save`.  For objects which have not yet
@@ -74,30 +79,42 @@ need the same information).
     the filesystem no longer matches the recorded hash). 
     If this is a problem for you, use `--status`.
     
--l, --long
+-l, \--long
 :   print more information about each file, in a similar
     format to the `-l` option to `ls`(1).
 
--x, --xdev, --one-file-system
+-x, \--xdev, \--one-file-system
 :   don't cross filesystem boundaries when recursing
     through the filesystem.  Only applicable if you're
     using `-u`.
     
---fake-valid
+\--fake-valid
 :   mark specified filenames as up-to-date even if they
     aren't.  This can be useful for testing, or to avoid
     unnecessarily backing up files that you know are
     boring.
     
---check
+\--fake-invalid
+:   mark specified filenames as not up-to-date, forcing the
+    next "bup save" run to re-check their contents.
+    
+\--check
 :   carefully check index file integrity before and after
     updating.  Mostly useful for automated tests.
 
--f, --indexfile=*indexfile*
+-f, \--indexfile=*indexfile*
 :   use a different index filename instead of
     `~/.bup/bupindex`.
 
--v, --verbose
+\--exclude=*path*
+:   a path to exclude from the backup (can be used more
+    than once)
+
+\--exclude-from=*filename*
+:   a file that contains exclude paths (can be used more
+    than once)
+
+-v, \--verbose
 :   increase log output during update (can be used more
     than once).  With one `-v`, print each directory as it
     is updated; with two `-v`, print each file too.