1af406aca219221f6299bbb28672dccefd6e4ab8
[git/git.git] / Documentation / git-multi-pack-index.txt
1 git-multi-pack-index(1)
2 =======================
3
4 NAME
5 ----
6 git-multi-pack-index - Write and verify multi-pack-indexes
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git multi-pack-index' [--object-dir=<dir>] <subcommand>
13
14 DESCRIPTION
15 -----------
16 Write or verify a multi-pack-index (MIDX) file.
17
18 OPTIONS
19 -------
20
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.
25
26 The following subcommands are available:
27
28 write::
29 Write a new MIDX file.
30
31 verify::
32 Verify the contents of the MIDX file.
33
34
35 EXAMPLES
36 --------
37
38 * Write a MIDX file for the packfiles in the current .git folder.
39 +
40 -----------------------------------------------
41 $ git multi-pack-index write
42 -----------------------------------------------
43
44 * Write a MIDX file for the packfiles in an alternate object store.
45 +
46 -----------------------------------------------
47 $ git multi-pack-index --object-dir <alt> write
48 -----------------------------------------------
49
50 * Verify the MIDX file for the packfiles in the current .git folder.
51 +
52 -----------------------------------------------
53 $ git multi-pack-index verify
54 -----------------------------------------------
55
56
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.
62
63
64 GIT
65 ---
66 Part of the linkgit:git[1] suite