multi-pack-index: prepare for 'expire' subcommand
[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]
81efa161 12'git multi-pack-index' [--object-dir=<dir>] <subcommand>
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
81efa161
DS
26The following subcommands are available:
27
a3407730 28write::
81efa161 29 Write a new MIDX file.
a3407730 30
56ee7ff1 31verify::
81efa161 32 Verify the contents of the MIDX file.
56ee7ff1 33
cff97116
DS
34expire::
35 Delete the pack-files that are tracked by the MIDX file, but
36 have no objects referenced by the MIDX. Rewrite the MIDX file
37 afterward to remove all references to these pack-files.
38
a3407730
DS
39
40EXAMPLES
41--------
42
43* Write a MIDX file for the packfiles in the current .git folder.
44+
45-----------------------------------------------
46$ git multi-pack-index write
47-----------------------------------------------
48
49* Write a MIDX file for the packfiles in an alternate object store.
50+
51-----------------------------------------------
52$ git multi-pack-index --object-dir <alt> write
53-----------------------------------------------
54
56ee7ff1
DS
55* Verify the MIDX file for the packfiles in the current .git folder.
56+
57-----------------------------------------------
58$ git multi-pack-index verify
59-----------------------------------------------
60
6a257f03
DS
61
62SEE ALSO
63--------
64See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
65Document] and link:technical/pack-format.html[The Multi-Pack-Index
66Format] for more information on the multi-pack-index feature.
67
68
69GIT
70---
71Part of the linkgit:git[1] suite