Update base_version to 0.34~ for 0.34 development

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

diff --git a/Documentation/bup-index.md b/Documentation/bup-index.md
index 47992d1c7dbb7c37d62a8558b840542d37d5cc4d..734009556246383894fadb658bed2c3171d98fb5 100644 (file)
--- a/Documentation/bup-index.md
+++ b/Documentation/bup-index.md
@@ -11,15 +11,14 @@ bup-index - print and/or update the bup filesystem index
 bup index \<-p|-m|-s|-u|\--clear|\--check\> [-H] [-l] [-x] [\--fake-valid]
 [\--no-check-device] [\--fake-invalid] [-f *indexfile*] [\--exclude *path*]
 [\--exclude-from *filename*] [\--exclude-rx *pattern*]
-[\--exclude-rx-from *filename*] [-v] \<filenames...\>
+[\--exclude-rx-from *filename*] [-v] \<paths...\>
 
 # DESCRIPTION
 
-`bup index` prints and/or updates the bup filesystem index,
-which is a cache of the filenames, attributes, and sha-1
-hashes of each file and directory in the filesystem.  The
-bup index is similar in function to the `git`(1) index, and
-can be found in `$BUP_DIR/bupindex`.
+`bup index` manipulates the filesystem index, which is a cache of
+absolute paths and their metadata (attributes, SHA-1 hashes, etc.).
+The bup index is similar in function to the `git`(1) index, and the
+default index can be found in `$BUP_DIR/bupindex`.
 
 Creating a backup in bup consists of two steps: updating
 the index with `bup index`, then actually backing up the
@@ -89,15 +88,17 @@ does, due to the accommodations described above.
 # MODES
 
 -u, \--update
-:   recursively update the index for the given filenames and
-    their descendants.  One or more filenames must be
-    given.  If no mode option is given, this is the
-    default.
+:   recursively update the index for the given paths and their
+    descendants.  One or more paths must be specified, and if a path
+    ends with a symbolic link, the link itself will be indexed, not
+    the target.  If no mode option is given, `--update` is the
+    default, and paths may be excluded by the `--exclude`,
+    `--exclude-rx`, and `--one-file-system` options.
 
 -p, \--print
-:   print the contents of the index.  If filenames are
+:   print the contents of the index.  If paths are
     given, shows the given entries and their descendants. 
-    If no filenames are given, shows the entries starting
+    If no paths are given, shows the entries starting
     at the current working directory (.).
     
 -m, \--modified
@@ -107,7 +108,7 @@ does, due to the accommodations described above.
 
 -s, \--status
 :   prepend a status code (A, M, D, or space) before each
-    filename.  Implies `-p`.  The codes mean, respectively,
+    path.  Implies `-p`.  The codes mean, respectively,
     that a file is marked in the index as added, modified,
     deleted, or unchanged since the last backup.
 
@@ -137,19 +138,19 @@ does, due to the accommodations described above.
     format to the `-l` option to `ls`(1).
 
 -x, \--xdev, \--one-file-system
-:   don't cross filesystem boundaries when recursing through the
+:   don't cross filesystem boundaries when traversing the
     filesystem -- though as with tar and rsync, the mount points
     themselves will still be indexed.  Only applicable if you're using
     `-u`.
     
 \--fake-valid
-:   mark specified filenames as up-to-date even if they
+:   mark specified paths 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.
     
 \--fake-invalid
-:   mark specified filenames as not up-to-date, forcing the
+:   mark specified paths as not up-to-date, forcing the
     next "bup save" run to re-check their contents.
 
 -f, \--indexfile=*indexfile*