enable index-pack streaming capability
[git/debian.git] / Documentation / git-index-pack.txt
blobdb7af5859e90b02ec74ddad91cd46fab01c86e62
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' [-o <index-file>] { <pack-file> | --stdin [<pack-file>] }
14 DESCRIPTION
15 -----------
16 Reads a packed archive (.pack) from the specified file, and
17 builds a pack index file (.idx) for it.  The packed archive
18 together with the pack index can then be placed in the
19 objects/pack/ directory of a git repository.
22 OPTIONS
23 -------
24 -o <index-file>::
25         Write the generated pack index into the specified
26         file.  Without this option the name of pack index
27         file is constructed from the name of packed archive
28         file by replacing .pack with .idx (and the program
29         fails if the name of packed archive does not end
30         with .pack).
32 --stdin::
33         When this flag is provided, the pack is read from stdin
34         instead and a copy is then written to <pack-file>. If
35         <pack-file> is not specified, the pack is written to
36         objects/pack/ directory of the current git repository with
37         a default name determined from the pack content.
39 Author
40 ------
41 Written by Sergey Vlasov <vsu@altlinux.ru>
43 Documentation
44 -------------
45 Documentation by Sergey Vlasov
47 GIT
48 ---
49 Part of the gitlink:git[7] suite