blob: be7c6d2612388851cd6dd043b9c9bec3158ca863 [file] [log] [blame]
'\" t
.\" Title: git-show-index
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/18/2018
.\" Manual: Git Manual
.\" Source: Git 2.20.0.rc0
.\" Language: English
.\"
.TH "GIT\-SHOW\-INDEX" "1" "11/18/2018" "Git 2\&.20\&.0\&.rc0" "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
.fi
.sp
.SH "DESCRIPTION"
.sp
Read the \fB\&.idx\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 "GIT"
.sp
Part of the \fBgit\fR(1) suite