git-index-pack.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-index-pack(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-index-pack(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-index-pack -
 317    Build pack index file for an existing packed archive
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="verseblock">
 324 <div class="content"><em>git index-pack</em> [-v] [-o &lt;index-file&gt;] &lt;pack-file&gt;
 325 <em>git index-pack</em> --stdin [--fix-thin] [--keep] [-v] [-o &lt;index-file&gt;]
 326                  [&lt;pack-file&gt;]</div></div>
 327 </div>
 328 <h2 id="_description">DESCRIPTION</h2>
 329 <div class="sectionbody">
 330 <div class="para"><p>Reads a packed archive (.pack) from the specified file, and
 331 builds a pack index file (.idx) for it.  The packed archive
 332 together with the pack index can then be placed in the
 333 objects/pack/ directory of a git repository.</p></div>
 334 </div>
 335 <h2 id="_options">OPTIONS</h2>
 336 <div class="sectionbody">
 337 <div class="vlist"><dl>
 338 <dt>
 339 -v
 340 </dt>
 341 <dd>
 342 <p>
 343         Be verbose about what is going on, including progress status.
 344 </p>
 345 </dd>
 346 <dt>
 347 -o &lt;index-file&gt;
 348 </dt>
 349 <dd>
 350 <p>
 351         Write the generated pack index into the specified
 352         file.  Without this option the name of pack index
 353         file is constructed from the name of packed archive
 354         file by replacing .pack with .idx (and the program
 355         fails if the name of packed archive does not end
 356         with .pack).
 357 </p>
 358 </dd>
 359 <dt>
 360 --stdin
 361 </dt>
 362 <dd>
 363 <p>
 364         When this flag is provided, the pack is read from stdin
 365         instead and a copy is then written to &lt;pack-file&gt;. If
 366         &lt;pack-file&gt; is not specified, the pack is written to
 367         objects/pack/ directory of the current git repository with
 368         a default name determined from the pack content.  If
 369         &lt;pack-file&gt; is not specified consider using --keep to
 370         prevent a race condition between this process and
 371         <em>git repack</em>.
 372 </p>
 373 </dd>
 374 <dt>
 375 --fix-thin
 376 </dt>
 377 <dd>
 378 <p>
 379         Fix a "thin" pack produced by <tt>git pack-objects --thin</tt> (see
 380         <a href="git-pack-objects.html">git-pack-objects(1)</a> for details) by adding the
 381         excluded objects the deltified objects are based on to the
 382         pack. This option only makes sense in conjunction with --stdin.
 383 </p>
 384 </dd>
 385 <dt>
 386 --keep
 387 </dt>
 388 <dd>
 389 <p>
 390         Before moving the index into its final destination
 391         create an empty .keep file for the associated pack file.
 392         This option is usually necessary with --stdin to prevent a
 393         simultaneous <em>git repack</em> process from deleting
 394         the newly constructed pack and index before refs can be
 395         updated to use objects contained in the pack.
 396 </p>
 397 </dd>
 398 <dt>
 399 --keep=<em>why</em>
 400 </dt>
 401 <dd>
 402 <p>
 403         Like --keep create a .keep file before moving the index into
 404         its final destination, but rather than creating an empty file
 405         place <em>why</em> followed by an LF into the .keep file.  The <em>why</em>
 406         message can later be searched for within all .keep files to
 407         locate any which have outlived their usefulness.
 408 </p>
 409 </dd>
 410 <dt>
 411 --index-version=&lt;version&gt;[,&lt;offset&gt;]
 412 </dt>
 413 <dd>
 414 <p>
 415         This is intended to be used by the test suite only. It allows
 416         to force the version for the generated pack index, and to force
 417         64-bit index entries on objects located above the given offset.
 418 </p>
 419 </dd>
 420 <dt>
 421 --strict
 422 </dt>
 423 <dd>
 424 <p>
 425         Die, if the pack contains broken objects or links.
 426 </p>
 427 </dd>
 428 </dl></div>
 429 </div>
 430 <h2 id="_note">Note</h2>
 431 <div class="sectionbody">
 432 <div class="para"><p>Once the index has been created, the list of object names is sorted
 433 and the SHA1 hash of that list is printed to stdout. If --stdin was
 434 also used then this is prefixed by either "pack\t", or "keep\t" if a
 435 new .keep file was successfully created. This is useful to remove a
 436 .keep file used as a lock to prevent the race with <em>git repack</em>
 437 mentioned above.</p></div>
 438 </div>
 439 <h2 id="_author">Author</h2>
 440 <div class="sectionbody">
 441 <div class="para"><p>Written by Sergey Vlasov &lt;vsu@altlinux.ru&gt;</p></div>
 442 </div>
 443 <h2 id="_documentation">Documentation</h2>
 444 <div class="sectionbody">
 445 <div class="para"><p>Documentation by Sergey Vlasov</p></div>
 446 </div>
 447 <h2 id="_git">GIT</h2>
 448 <div class="sectionbody">
 449 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 450 </div>
 451 <div id="footer">
 452 <div id="footer-text">
 453 Last updated 2010-02-19 09:57:44 UTC
 454 </div>
 455 </div>
 456 </body>
 457 </html>