multi-pack-index: add 'write' verb
[git/git.git] / Documentation / git-multi-pack-index.txt
CommitLineData
6a257f03
DS
1git-multi-pack-index(1)
2=======================
3
4NAME
5----
6git-multi-pack-index - Write and verify multi-pack-indexes
7
8
9SYNOPSIS
10--------
11[verse]
a3407730 12'git multi-pack-index' [--object-dir=<dir>] <verb>
6a257f03
DS
13
14DESCRIPTION
15-----------
16Write or verify a multi-pack-index (MIDX) file.
17
18OPTIONS
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
a3407730
DS
26write::
27 When given as the verb, write a new MIDX file to
28 `<dir>/packs/multi-pack-index`.
29
30
31EXAMPLES
32--------
33
34* Write a MIDX file for the packfiles in the current .git folder.
35+
36-----------------------------------------------
37$ git multi-pack-index write
38-----------------------------------------------
39
40* Write a MIDX file for the packfiles in an alternate object store.
41+
42-----------------------------------------------
43$ git multi-pack-index --object-dir <alt> write
44-----------------------------------------------
45
6a257f03
DS
46
47SEE ALSO
48--------
49See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
50Document] and link:technical/pack-format.html[The Multi-Pack-Index
51Format] for more information on the multi-pack-index feature.
52
53
54GIT
55---
56Part of the linkgit:git[1] suite