The twelfth batch
[git.git] / Documentation / git-show-index.txt
blobe49318a5a0aec7f46c6d23dbff5afcb920fae236
1 git-show-index(1)
2 =================
4 NAME
5 ----
6 git-show-index - Show packed archive index
9 SYNOPSIS
10 --------
11 [verse]
12 'git show-index' [--object-format=<hash-algorithm>]
15 DESCRIPTION
16 -----------
17 Read the `.idx` file for a Git packfile (created with
18 linkgit:git-pack-objects[1] or linkgit:git-index-pack[1]) from the
19 standard input, and dump its contents. The output consists of one object
20 per line, with each line containing two or three space-separated
21 columns:
23   - the first column is the offset in bytes of the object within the
24     corresponding packfile
26   - the second column is the object id of the object
28   - if the index version is 2 or higher, the third column contains the
29     CRC32 of the object data
31 The objects are output in the order in which they are found in the index
32 file, which should be (in a correctly constructed file) sorted by object
33 id.
35 Note that you can get more information on a packfile by calling
36 linkgit:git-verify-pack[1]. However, as this command considers only the
37 index file itself, it's both faster and more flexible.
39 OPTIONS
40 -------
42 --object-format=<hash-algorithm>::
43         Specify the given object format (hash algorithm) for the index file.  The
44         valid values are 'sha1' and (if enabled) 'sha256'.  The default is the
45         algorithm for the current repository (set by `extensions.objectFormat`), or
46         'sha1' if no value is set or outside a repository..
48 include::object-format-disclaimer.txt[]
50 GIT
51 ---
52 Part of the linkgit:git[1] suite