Autogenerated HTML docs for v1.7.7-325-g05f6ed
[git/jnareb-git.git] / git-checkout-index.html
blob9a00b4b5e098d9a75bf6ad450a4c1bab046175bd
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.5.2" />
7 <title>git-checkout-index(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-checkout-index(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-checkout-index -
578 Copy files from the index to the working tree
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]
587 [--stage=&lt;number&gt;|all]
588 [--temp]
589 [-z] [--stdin]
590 [--] [&lt;file&gt;&#8230;]</div>
591 <div class="verseblock-attribution">
592 </div></div>
593 </div>
594 <h2 id="_description">DESCRIPTION</h2>
595 <div class="sectionbody">
596 <div class="paragraph"><p>Will copy all files listed from the index to the working directory
597 (not overwriting existing files).</p></div>
598 </div>
599 <h2 id="_options">OPTIONS</h2>
600 <div class="sectionbody">
601 <div class="dlist"><dl>
602 <dt class="hdlist1">
604 </dt>
605 <dt class="hdlist1">
606 --index
607 </dt>
608 <dd>
610 update stat information for the checked out entries in
611 the index file.
612 </p>
613 </dd>
614 <dt class="hdlist1">
616 </dt>
617 <dt class="hdlist1">
618 --quiet
619 </dt>
620 <dd>
622 be quiet if files exist or are not in the index
623 </p>
624 </dd>
625 <dt class="hdlist1">
627 </dt>
628 <dt class="hdlist1">
629 --force
630 </dt>
631 <dd>
633 forces overwrite of existing files
634 </p>
635 </dd>
636 <dt class="hdlist1">
638 </dt>
639 <dt class="hdlist1">
640 --all
641 </dt>
642 <dd>
644 checks out all files in the index. Cannot be used
645 together with explicit filenames.
646 </p>
647 </dd>
648 <dt class="hdlist1">
650 </dt>
651 <dt class="hdlist1">
652 --no-create
653 </dt>
654 <dd>
656 Don&#8217;t checkout new files, only refresh files already checked
657 out.
658 </p>
659 </dd>
660 <dt class="hdlist1">
661 --prefix=&lt;string&gt;
662 </dt>
663 <dd>
665 When creating files, prepend &lt;string&gt; (usually a directory
666 including a trailing /)
667 </p>
668 </dd>
669 <dt class="hdlist1">
670 --stage=&lt;number&gt;|all
671 </dt>
672 <dd>
674 Instead of checking out unmerged entries, copy out the
675 files from named stage. &lt;number&gt; must be between 1 and 3.
676 Note: --stage=all automatically implies --temp.
677 </p>
678 </dd>
679 <dt class="hdlist1">
680 --temp
681 </dt>
682 <dd>
684 Instead of copying the files to the working directory
685 write the content to temporary files. The temporary name
686 associations will be written to stdout.
687 </p>
688 </dd>
689 <dt class="hdlist1">
690 --stdin
691 </dt>
692 <dd>
694 Instead of taking list of paths from the command line,
695 read list of paths from the standard input. Paths are
696 separated by LF (i.e. one path per line) by default.
697 </p>
698 </dd>
699 <dt class="hdlist1">
701 </dt>
702 <dd>
704 Only meaningful with <tt>--stdin</tt>; paths are separated with
705 NUL character instead of LF.
706 </p>
707 </dd>
708 <dt class="hdlist1">
710 </dt>
711 <dd>
713 Do not interpret any more arguments as options.
714 </p>
715 </dd>
716 </dl></div>
717 <div class="paragraph"><p>The order of the flags used to matter, but not anymore.</p></div>
718 <div class="paragraph"><p>Just doing <tt>git checkout-index</tt> does nothing. You probably meant
719 <tt>git checkout-index -a</tt>. And if you want to force it, you want
720 <tt>git checkout-index -f -a</tt>.</p></div>
721 <div class="paragraph"><p>Intuitiveness is not the goal here. Repeatability is. The reason for
722 the "no arguments means no work" behavior is that from scripts you are
723 supposed to be able to do:</p></div>
724 <div class="listingblock">
725 <div class="content">
726 <pre><tt>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</tt></pre>
727 </div></div>
728 <div class="paragraph"><p>which will force all existing <tt>*.h</tt> files to be replaced with their
729 cached copies. If an empty command line implied "all", then this would
730 force-refresh everything in the index, which was not the point. But
731 since <em>git checkout-index</em> accepts --stdin it would be faster to use:</p></div>
732 <div class="listingblock">
733 <div class="content">
734 <pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</tt></pre>
735 </div></div>
736 <div class="paragraph"><p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;
737 it will prevent problems with a filename of, for example, <tt>-a</tt>.
738 Using <tt>--</tt> is probably a good policy in scripts.</p></div>
739 </div>
740 <h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2>
741 <div class="sectionbody">
742 <div class="paragraph"><p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)
743 <em>git checkout-index</em> will create a temporary file for each index
744 entry being checked out. The index will not be updated with stat
745 information. These options can be useful if the caller needs all
746 stages of all unmerged entries so that the unmerged files can be
747 processed by an external merge tool.</p></div>
748 <div class="paragraph"><p>A listing will be written to stdout providing the association of
749 temporary file names to tracked path names. The listing format
750 has two variations:</p></div>
751 <div class="olist arabic"><ol class="arabic">
752 <li>
754 tempname TAB path RS
755 </p>
756 <div class="paragraph"><p>The first format is what gets used when <tt>--stage</tt> is omitted or
757 is not <tt>--stage=all</tt>. The field tempname is the temporary file
758 name holding the file content and path is the tracked path name in
759 the index. Only the requested entries are output.</p></div>
760 </li>
761 <li>
763 stage1temp SP stage2temp SP stage3tmp TAB path RS
764 </p>
765 <div class="paragraph"><p>The second format is what gets used when <tt>--stage=all</tt>. The three
766 stage temporary fields (stage1temp, stage2temp, stage3temp) list the
767 name of the temporary file if there is a stage entry in the index
768 or <tt>.</tt> if there is no stage entry. Paths which only have a stage 0
769 entry will always be omitted from the output.</p></div>
770 </li>
771 </ol></div>
772 <div class="paragraph"><p>In both formats RS (the record separator) is newline by default
773 but will be the null byte if -z was passed on the command line.
774 The temporary file names are always safe strings; they will never
775 contain directory separators or whitespace characters. The path
776 field is always relative to the current directory and the temporary
777 file names are always relative to the top level directory.</p></div>
778 <div class="paragraph"><p>If the object being copied out to a temporary file is a symbolic
779 link the content of the link will be written to a normal file. It is
780 up to the end-user or the Porcelain to make use of this information.</p></div>
781 </div>
782 <h2 id="_examples">EXAMPLES</h2>
783 <div class="sectionbody">
784 <div class="dlist"><dl>
785 <dt class="hdlist1">
786 To update and refresh only the files already checked out
787 </dt>
788 <dd>
789 <div class="listingblock">
790 <div class="content">
791 <pre><tt>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</tt></pre>
792 </div></div>
793 </dd>
794 <dt class="hdlist1">
795 Using <em>git checkout-index</em> to "export an entire tree"
796 </dt>
797 <dd>
799 The prefix ability basically makes it trivial to use
800 <em>git checkout-index</em> as an "export as tree" function.
801 Just read the desired tree into the index, and do:
802 </p>
803 <div class="listingblock">
804 <div class="content">
805 <pre><tt>$ git checkout-index --prefix=git-export-dir/ -a</tt></pre>
806 </div></div>
807 <div class="paragraph"><p><tt>git checkout-index</tt> will "export" the index into the specified
808 directory.</p></div>
809 <div class="paragraph"><p>The final "/" is important. The exported name is literally just
810 prefixed with the specified string. Contrast this with the
811 following example.</p></div>
812 </dd>
813 <dt class="hdlist1">
814 Export files with a prefix
815 </dt>
816 <dd>
817 <div class="listingblock">
818 <div class="content">
819 <pre><tt>$ git checkout-index --prefix=.merged- Makefile</tt></pre>
820 </div></div>
821 <div class="paragraph"><p>This will check out the currently cached copy of <tt>Makefile</tt>
822 into the file <tt>.merged-Makefile</tt>.</p></div>
823 </dd>
824 </dl></div>
825 </div>
826 <h2 id="_git">GIT</h2>
827 <div class="sectionbody">
828 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
829 </div>
830 </div>
831 <div id="footnotes"><hr /></div>
832 <div id="footer">
833 <div id="footer-text">
834 Last updated 2011-09-21 23:01:14 PDT
835 </div>
836 </div>
837 </body>
838 </html>