add progress status to index-pack
[git/jnareb-git.git] / Documentation / git-index-pack.txt
blob9fa4847d56be0844b91a7cbe76ead6c45a9e5bed
1 git-index-pack(1)
2 =================
4 NAME
5 ----
6 git-index-pack - Build pack index file for an existing packed archive
9 SYNOPSIS
10 --------
11 'git-index-pack' [-v] [-o <index-file>] <pack-file>
12 'git-index-pack' --stdin [--fix-thin] [-v] [-o <index-file>] [<pack-file>]
15 DESCRIPTION
16 -----------
17 Reads a packed archive (.pack) from the specified file, and
18 builds a pack index file (.idx) for it.  The packed archive
19 together with the pack index can then be placed in the
20 objects/pack/ directory of a git repository.
23 OPTIONS
24 -------
25 -v::
26         Be verbose about what is going on, including progress status.
28 -o <index-file>::
29         Write the generated pack index into the specified
30         file.  Without this option the name of pack index
31         file is constructed from the name of packed archive
32         file by replacing .pack with .idx (and the program
33         fails if the name of packed archive does not end
34         with .pack).
36 --stdin::
37         When this flag is provided, the pack is read from stdin
38         instead and a copy is then written to <pack-file>. If
39         <pack-file> is not specified, the pack is written to
40         objects/pack/ directory of the current git repository with
41         a default name determined from the pack content.
43 --fix-thin::
44         It is possible for gitlink:git-pack-objects[1] to build
45         "thin" pack, which records objects in deltified form based on
46         objects not included in the pack to reduce network traffic.
47         Those objects are expected to be present on the receiving end
48         and they must be included in the pack for that pack to be self
49         contained and indexable. Without this option any attempt to
50         index a thin pack will fail. This option only makes sense in
51         conjonction with --stdin.
54 Author
55 ------
56 Written by Sergey Vlasov <vsu@altlinux.ru>
58 Documentation
59 -------------
60 Documentation by Sergey Vlasov
62 GIT
63 ---
64 Part of the gitlink:git[7] suite