git-show-index.1 (3441B)
- '\" t
- .\" Title: git-show-index
- .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
- .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
- .\" Date: 2025-03-14
- .\" Manual: Git Manual
- .\" Source: Git 2.49.0
- .\" Language: English
- .\"
- .TH "GIT\-SHOW\-INDEX" "1" "2025-03-14" "Git 2\&.49\&.0" "Git Manual"
- .\" -----------------------------------------------------------------
- .\" * Define some portability stuff
- .\" -----------------------------------------------------------------
- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- .\" http://bugs.debian.org/507673
- .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- .ie \n(.g .ds Aq \(aq
- .el .ds Aq '
- .\" -----------------------------------------------------------------
- .\" * set default formatting
- .\" -----------------------------------------------------------------
- .\" disable hyphenation
- .nh
- .\" disable justification (adjust text to left margin only)
- .ad l
- .\" -----------------------------------------------------------------
- .\" * MAIN CONTENT STARTS HERE *
- .\" -----------------------------------------------------------------
- .SH "NAME"
- git-show-index \- Show packed archive index
- .SH "SYNOPSIS"
- .sp
- .nf
- \fIgit show\-index\fR [\-\-object\-format=<hash\-algorithm>] < <pack\-idx\-file>
- .fi
- .SH "DESCRIPTION"
- .sp
- Read the \&.\fBidx\fR file for a Git packfile (created with \fBgit-pack-objects\fR(1) or \fBgit-index-pack\fR(1)) from the standard input, and dump its contents\&. The output consists of one object per line, with each line containing two or three space\-separated columns:
- .sp
- .RS 4
- .ie n \{\
- \h'-04'\(bu\h'+03'\c
- .\}
- .el \{\
- .sp -1
- .IP \(bu 2.3
- .\}
- the first column is the offset in bytes of the object within the corresponding packfile
- .RE
- .sp
- .RS 4
- .ie n \{\
- \h'-04'\(bu\h'+03'\c
- .\}
- .el \{\
- .sp -1
- .IP \(bu 2.3
- .\}
- the second column is the object id of the object
- .RE
- .sp
- .RS 4
- .ie n \{\
- \h'-04'\(bu\h'+03'\c
- .\}
- .el \{\
- .sp -1
- .IP \(bu 2.3
- .\}
- if the index version is 2 or higher, the third column contains the CRC32 of the object data
- .RE
- .sp
- The objects are output in the order in which they are found in the index file, which should be (in a correctly constructed file) sorted by object id\&.
- .sp
- Note that you can get more information on a packfile by calling \fBgit-verify-pack\fR(1)\&. However, as this command considers only the index file itself, it\(cqs both faster and more flexible\&.
- .SH "OPTIONS"
- .PP
- \-\-object\-format=<hash\-algorithm>
- .RS 4
- Specify the given object format (hash algorithm) for the index file\&. The valid values are
- \fIsha1\fR
- and (if enabled)
- \fIsha256\fR\&. The default is the algorithm for the current repository (set by
- \fBextensions\&.objectFormat\fR), or
- \fIsha1\fR
- if no value is set or outside a repository\&.\&.
- .sp
- Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
- .RE
- .sp
- Historically, we warned that SHA\-256 repositories may later need backward incompatible changes when we introduce such interoperability features\&. Today, we only expect compatible changes\&. Furthermore, if such changes prove to be necessary, it can be expected that SHA\-256 repositories created with today\(cqs Git will be usable by future versions of Git without data loss\&.
- .SH "GIT"
- .sp
- Part of the \fBgit\fR(1) suite