Merge branch 'nd/packobjectshook-doc-fix'
[git.git] / Documentation / git-multi-pack-index.txt
blobf7778a2c85c1aaa1295dbf3b9e4f74f3683def23
1 git-multi-pack-index(1)
2 =======================
4 NAME
5 ----
6 git-multi-pack-index - Write and verify multi-pack-indexes
9 SYNOPSIS
10 --------
11 [verse]
12 'git multi-pack-index' [--object-dir=<dir>] <verb>
14 DESCRIPTION
15 -----------
16 Write or verify a multi-pack-index (MIDX) file.
18 OPTIONS
19 -------
21 --object-dir=<dir>::
22         Use given directory for the location of Git objects. We check
23         `<dir>/packs/multi-pack-index` for the current MIDX file, and
24         `<dir>/packs` for the pack-files to index.
26 write::
27         When given as the verb, write a new MIDX file to
28         `<dir>/packs/multi-pack-index`.
30 verify::
31         When given as the verb, verify the contents of the MIDX file
32         at `<dir>/packs/multi-pack-index`.
35 EXAMPLES
36 --------
38 * Write a MIDX file for the packfiles in the current .git folder.
40 -----------------------------------------------
41 $ git multi-pack-index write
42 -----------------------------------------------
44 * Write a MIDX file for the packfiles in an alternate object store.
46 -----------------------------------------------
47 $ git multi-pack-index --object-dir <alt> write
48 -----------------------------------------------
50 * Verify the MIDX file for the packfiles in the current .git folder.
52 -----------------------------------------------
53 $ git multi-pack-index verify
54 -----------------------------------------------
57 SEE ALSO
58 --------
59 See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
60 Document] and link:technical/pack-format.html[The Multi-Pack-Index
61 Format] for more information on the multi-pack-index feature.
64 GIT
65 ---
66 Part of the linkgit:git[1] suite