git-checkout-index.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-checkout-index(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-checkout-index(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-checkout-index -
 743    Copy files from the index to the working tree
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]
 753                    [--stage=&lt;number&gt;|all]
 754                    [--temp]
 755                    [--ignore-skip-worktree-bits]
 756                    [-z] [--stdin]
 757                    [--] [&lt;file&gt;&#8230;]</pre>
 758 <div class="attribution">
 759 </div></div>
 760 </div>
 761 </div>
 762 <div class="sect1">
 763 <h2 id="_description">DESCRIPTION</h2>
 764 <div class="sectionbody">
 765 <div class="paragraph"><p>Will copy all files listed from the index to the working directory
 766 (not overwriting existing files).</p></div>
 767 </div>
 768 </div>
 769 <div class="sect1">
 770 <h2 id="_options">OPTIONS</h2>
 771 <div class="sectionbody">
 772 <div class="dlist"><dl>
 773 <dt class="hdlist1">
 774 -u
 775 </dt>
 776 <dt class="hdlist1">
 777 --index
 778 </dt>
 779 <dd>
 780 <p>
 781         update stat information for the checked out entries in
 782         the index file.
 783 </p>
 784 </dd>
 785 <dt class="hdlist1">
 786 -q
 787 </dt>
 788 <dt class="hdlist1">
 789 --quiet
 790 </dt>
 791 <dd>
 792 <p>
 793         be quiet if files exist or are not in the index
 794 </p>
 795 </dd>
 796 <dt class="hdlist1">
 797 -f
 798 </dt>
 799 <dt class="hdlist1">
 800 --force
 801 </dt>
 802 <dd>
 803 <p>
 804         forces overwrite of existing files
 805 </p>
 806 </dd>
 807 <dt class="hdlist1">
 808 -a
 809 </dt>
 810 <dt class="hdlist1">
 811 --all
 812 </dt>
 813 <dd>
 814 <p>
 815         checks out all files in the index except for those with the
 816         skip-worktree bit set (see <code>--ignore-skip-worktree-bits</code>).
 817         Cannot be used together with explicit filenames.
 818 </p>
 819 </dd>
 820 <dt class="hdlist1">
 821 -n
 822 </dt>
 823 <dt class="hdlist1">
 824 --no-create
 825 </dt>
 826 <dd>
 827 <p>
 828         Don&#8217;t checkout new files, only refresh files already checked
 829         out.
 830 </p>
 831 </dd>
 832 <dt class="hdlist1">
 833 --prefix=&lt;string&gt;
 834 </dt>
 835 <dd>
 836 <p>
 837         When creating files, prepend &lt;string&gt; (usually a directory
 838         including a trailing /)
 839 </p>
 840 </dd>
 841 <dt class="hdlist1">
 842 --stage=&lt;number&gt;|all
 843 </dt>
 844 <dd>
 845 <p>
 846         Instead of checking out unmerged entries, copy out the
 847         files from named stage.  &lt;number&gt; must be between 1 and 3.
 848         Note: --stage=all automatically implies --temp.
 849 </p>
 850 </dd>
 851 <dt class="hdlist1">
 852 --temp
 853 </dt>
 854 <dd>
 855 <p>
 856         Instead of copying the files to the working directory
 857         write the content to temporary files.  The temporary name
 858         associations will be written to stdout.
 859 </p>
 860 </dd>
 861 <dt class="hdlist1">
 862 --ignore-skip-worktree-bits
 863 </dt>
 864 <dd>
 865 <p>
 866         Check out all files, including those with the skip-worktree bit
 867         set.
 868 </p>
 869 </dd>
 870 <dt class="hdlist1">
 871 --stdin
 872 </dt>
 873 <dd>
 874 <p>
 875         Instead of taking list of paths from the command line,
 876         read list of paths from the standard input.  Paths are
 877         separated by LF (i.e. one path per line) by default.
 878 </p>
 879 </dd>
 880 <dt class="hdlist1">
 881 -z
 882 </dt>
 883 <dd>
 884 <p>
 885         Only meaningful with <code>--stdin</code>; paths are separated with
 886         NUL character instead of LF.
 887 </p>
 888 </dd>
 889 <dt class="hdlist1">
 890 --
 891 </dt>
 892 <dd>
 893 <p>
 894         Do not interpret any more arguments as options.
 895 </p>
 896 </dd>
 897 </dl></div>
 898 <div class="paragraph"><p>The order of the flags used to matter, but not anymore.</p></div>
 899 <div class="paragraph"><p>Just doing <code>git checkout-index</code> does nothing. You probably meant
 900 <code>git checkout-index -a</code>. And if you want to force it, you want
 901 <code>git checkout-index -f -a</code>.</p></div>
 902 <div class="paragraph"><p>Intuitiveness is not the goal here. Repeatability is. The reason for
 903 the "no arguments means no work" behavior is that from scripts you are
 904 supposed to be able to do:</p></div>
 905 <div class="listingblock">
 906 <div class="content">
 907 <pre><code>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</code></pre>
 908 </div></div>
 909 <div class="paragraph"><p>which will force all existing <code>*.h</code> files to be replaced with their
 910 cached copies. If an empty command line implied "all", then this would
 911 force-refresh everything in the index, which was not the point.  But
 912 since <em>git checkout-index</em> accepts --stdin it would be faster to use:</p></div>
 913 <div class="listingblock">
 914 <div class="content">
 915 <pre><code>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</code></pre>
 916 </div></div>
 917 <div class="paragraph"><p>The <code>--</code> is just a good idea when you know the rest will be filenames;
 918 it will prevent problems with a filename of, for example,  <code>-a</code>.
 919 Using <code>--</code> is probably a good policy in scripts.</p></div>
 920 </div>
 921 </div>
 922 <div class="sect1">
 923 <h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2>
 924 <div class="sectionbody">
 925 <div class="paragraph"><p>When <code>--temp</code> is used (or implied by <code>--stage=all</code>)
 926 <em>git checkout-index</em> will create a temporary file for each index
 927 entry being checked out.  The index will not be updated with stat
 928 information.  These options can be useful if the caller needs all
 929 stages of all unmerged entries so that the unmerged files can be
 930 processed by an external merge tool.</p></div>
 931 <div class="paragraph"><p>A listing will be written to stdout providing the association of
 932 temporary file names to tracked path names.  The listing format
 933 has two variations:</p></div>
 934 <div class="olist arabic"><ol class="arabic">
 935 <li>
 936 <p>
 937 tempname TAB path RS
 938 </p>
 939 <div class="paragraph"><p>The first format is what gets used when <code>--stage</code> is omitted or
 940 is not <code>--stage=all</code>. The field tempname is the temporary file
 941 name holding the file content and path is the tracked path name in
 942 the index.  Only the requested entries are output.</p></div>
 943 </li>
 944 <li>
 945 <p>
 946 stage1temp SP stage2temp SP stage3tmp TAB path RS
 947 </p>
 948 <div class="paragraph"><p>The second format is what gets used when <code>--stage=all</code>.  The three
 949 stage temporary fields (stage1temp, stage2temp, stage3temp) list the
 950 name of the temporary file if there is a stage entry in the index
 951 or <code>.</code> if there is no stage entry.  Paths which only have a stage 0
 952 entry will always be omitted from the output.</p></div>
 953 </li>
 954 </ol></div>
 955 <div class="paragraph"><p>In both formats RS (the record separator) is newline by default
 956 but will be the null byte if -z was passed on the command line.
 957 The temporary file names are always safe strings; they will never
 958 contain directory separators or whitespace characters.  The path
 959 field is always relative to the current directory and the temporary
 960 file names are always relative to the top level directory.</p></div>
 961 <div class="paragraph"><p>If the object being copied out to a temporary file is a symbolic
 962 link the content of the link will be written to a normal file.  It is
 963 up to the end-user or the Porcelain to make use of this information.</p></div>
 964 </div>
 965 </div>
 966 <div class="sect1">
 967 <h2 id="_examples">EXAMPLES</h2>
 968 <div class="sectionbody">
 969 <div class="dlist"><dl>
 970 <dt class="hdlist1">
 971 To update and refresh only the files already checked out
 972 </dt>
 973 <dd>
 974 <div class="listingblock">
 975 <div class="content">
 976 <pre><code>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</code></pre>
 977 </div></div>
 978 </dd>
 979 <dt class="hdlist1">
 980 Using <em>git checkout-index</em> to "export an entire tree"
 981 </dt>
 982 <dd>
 983 <p>
 984         The prefix ability basically makes it trivial to use
 985         <em>git checkout-index</em> as an "export as tree" function.
 986         Just read the desired tree into the index, and do:
 987 </p>
 988 <div class="listingblock">
 989 <div class="content">
 990 <pre><code>$ git checkout-index --prefix=git-export-dir/ -a</code></pre>
 991 </div></div>
 992 <div class="paragraph"><p><code>git checkout-index</code> will "export" the index into the specified
 993 directory.</p></div>
 994 <div class="paragraph"><p>The final "/" is important. The exported name is literally just
 995 prefixed with the specified string.  Contrast this with the
 996 following example.</p></div>
 997 </dd>
 998 <dt class="hdlist1">
 999 Export files with a prefix
1000 </dt>
1001 <dd>
1002 <div class="listingblock">
1003 <div class="content">
1004 <pre><code>$ git checkout-index --prefix=.merged- Makefile</code></pre>
1005 </div></div>
1006 <div class="paragraph"><p>This will check out the currently cached copy of <code>Makefile</code>
1007 into the file <code>.merged-Makefile</code>.</p></div>
1008 </dd>
1009 </dl></div>
1010 </div>
1011 </div>
1012 <div class="sect1">
1013 <h2 id="_git">GIT</h2>
1014 <div class="sectionbody">
1015 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1016 </div>
1017 </div>
1018 </div>
1019 <div id="footnotes"><hr /></div>
1020 <div id="footer">
1021 <div id="footer-text">
1022 Last updated
1023  2022-02-17 16:38:18 PST
1024 </div>
1025 </div>
1026 </body>
1027 </html>