1 % bup-index(1) Bup %BUP_VERSION%
2 % Avery Pennarun <apenwarr@gmail.com>
7 bup-index - print and/or update the bup filesystem index
11 bup index <-p|-m|-u> [-s] [-H] [-l] [-x] [--fake-valid]
12 [--check] [-f *indexfile*] [--exclude *path*]
13 [--exclude-from *filename*] [-v] <filenames...>
17 `bup index` prints and/or updates the bup filesystem index,
18 which is a cache of the filenames, attributes, and sha-1
19 hashes of each file and directory in the filesystem. The
20 bup index is similar in function to the `git`(1) index, and
21 can be found in `~/.bup/bupindex`.
23 Creating a backup in bup consists of two steps: updating
24 the index with `bup index`, then actually backing up the
25 files (or a subset of the files) with `bup save`. The
26 separation exists for these reasons:
28 1. There is more than one way to generate a list of files
29 that need to be backed up. For example, you might want to
30 use `inotify`(7) or `dnotify`(7).
32 2. Even if you back up files to multiple destinations (for
33 added redundancy), the file names, attributes, and hashes
34 will be the same each time. Thus, you can save the trouble
35 of repeatedly re-generating the list of files for each
38 3. You may want to use the data tracked by bup index for
39 other purposes (such as speeding up other programs that
40 need the same information).
46 : (recursively) update the index for the given filenames and
47 their descendants. One or more filenames must be
51 : print the contents of the index. If filenames are
52 given, shows the given entries and their descendants.
53 If no filenames are given, shows the entries starting
54 at the current working directory (.).
57 : prints only files which are marked as modified (ie.
58 changed since the most recent backup) in the index.
62 : prepend a status code (A, M, D, or space) before each
63 filename. Implies `-p`. The codes mean, respectively,
64 that a file is marked in the index as added, modified,
65 deleted, or unchanged since the last backup.
68 : for each file printed, prepend the most recently
69 recorded hash code. The hash code is normally
70 generated by `bup save`. For objects which have not yet
71 been backed up, the hash code will be
72 0000000000000000000000000000000000000000. Note that
73 the hash code is printed even if the file is known to
74 be modified or deleted in the index (ie. the file on
75 the filesystem no longer matches the recorded hash).
76 If this is a problem for you, use `--status`.
79 : print more information about each file, in a similar
80 format to the `-l` option to `ls`(1).
82 -x, --xdev, --one-file-system
83 : don't cross filesystem boundaries when recursing
84 through the filesystem. Only applicable if you're
88 : mark specified filenames as up-to-date even if they
89 aren't. This can be useful for testing, or to avoid
90 unnecessarily backing up files that you know are
94 : carefully check index file integrity before and after
95 updating. Mostly useful for automated tests.
97 -f, --indexfile=*indexfile*
98 : use a different index filename instead of
102 : a path to exclude from the backup (can be used more
105 --exclude-from=*filename*
106 : a file that contains exclude paths (can be used more
110 : increase log output during update (can be used more
111 than once). With one `-v`, print each directory as it
112 is updated; with two `-v`, print each file too.
117 bup index -vux /etc /var /usr
122 `bup-save`(1), `bup-drecurse`(1), `bup-on`(1)
126 Part of the `bup`(1) suite.