man1/git-show-index.1

   1 '\" t
   2 .\"     Title: git-show-index
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 03/06/2023
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.40.0.rc2
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SHOW\-INDEX" "1" "03/06/2023" "Git 2\&.40\&.0\&.rc2" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-show-index \- Show packed archive index
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit show\-index\fR [\-\-object\-format=<hash\-algorithm>]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 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:
  41 .sp
  42 .RS 4
  43 .ie n \{\
  44 \h'-04'\(bu\h'+03'\c
  45 .\}
  46 .el \{\
  47 .sp -1
  48 .IP \(bu 2.3
  49 .\}
  50 the first column is the offset in bytes of the object within the corresponding packfile
  51 .RE
  52 .sp
  53 .RS 4
  54 .ie n \{\
  55 \h'-04'\(bu\h'+03'\c
  56 .\}
  57 .el \{\
  58 .sp -1
  59 .IP \(bu 2.3
  60 .\}
  61 the second column is the object id of the object
  62 .RE
  63 .sp
  64 .RS 4
  65 .ie n \{\
  66 \h'-04'\(bu\h'+03'\c
  67 .\}
  68 .el \{\
  69 .sp -1
  70 .IP \(bu 2.3
  71 .\}
  72 if the index version is 2 or higher, the third column contains the CRC32 of the object data
  73 .RE
  74 .sp
  75 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\&.
  76 .sp
  77 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\&.
  78 .SH "OPTIONS"
  79 .PP
  80 \-\-object\-format=<hash\-algorithm>
  81 .RS 4
  82 Specify the given object format (hash algorithm) for the index file\&. The valid values are
  83 \fIsha1\fR
  84 and (if enabled)
  85 \fIsha256\fR\&. The default is the algorithm for the current repository (set by
  86 \fBextensions\&.objectFormat\fR), or
  87 \fIsha1\fR
  88 if no value is set or outside a repository\&.\&.
  89 .sp
  90 THIS OPTION IS EXPERIMENTAL! SHA\-256 support is experimental and still in an early stage\&. A SHA\-256 repository will in general not be able to share work with "regular" SHA\-1 repositories\&. It should be assumed that, e\&.g\&., Git internal file formats in relation to SHA\-256 repositories may change in backwards\-incompatible ways\&. Only use
  91 \fB\-\-object\-format=sha256\fR
  92 for testing purposes\&.
  93 .RE
  94 .SH "GIT"
  95 .sp
  96 Part of the \fBgit\fR(1) suite