Autogenerated HTML docs for v1.7.5-134-g1c08
[git/jnareb-git.git] / git-checkout-index.html
blobb2345c7f9620b8d62712f2312c510300788fa95c
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.4.5" />
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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-checkout-index(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-checkout-index -
411 Copy files from the index to the working tree
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]
419 [--stage=&lt;number&gt;|all]
420 [--temp]
421 [-z] [--stdin]
422 [--] [&lt;file&gt;&#8230;]</div>
423 <div class="verseblock-attribution">
424 </div></div>
425 </div>
426 <h2 id="_description">DESCRIPTION</h2>
427 <div class="sectionbody">
428 <div class="paragraph"><p>Will copy all files listed from the index to the working directory
429 (not overwriting existing files).</p></div>
430 </div>
431 <h2 id="_options">OPTIONS</h2>
432 <div class="sectionbody">
433 <div class="dlist"><dl>
434 <dt class="hdlist1">
436 </dt>
437 <dt class="hdlist1">
438 --index
439 </dt>
440 <dd>
442 update stat information for the checked out entries in
443 the index file.
444 </p>
445 </dd>
446 <dt class="hdlist1">
448 </dt>
449 <dt class="hdlist1">
450 --quiet
451 </dt>
452 <dd>
454 be quiet if files exist or are not in the index
455 </p>
456 </dd>
457 <dt class="hdlist1">
459 </dt>
460 <dt class="hdlist1">
461 --force
462 </dt>
463 <dd>
465 forces overwrite of existing files
466 </p>
467 </dd>
468 <dt class="hdlist1">
470 </dt>
471 <dt class="hdlist1">
472 --all
473 </dt>
474 <dd>
476 checks out all files in the index. Cannot be used
477 together with explicit filenames.
478 </p>
479 </dd>
480 <dt class="hdlist1">
482 </dt>
483 <dt class="hdlist1">
484 --no-create
485 </dt>
486 <dd>
488 Don&#8217;t checkout new files, only refresh files already checked
489 out.
490 </p>
491 </dd>
492 <dt class="hdlist1">
493 --prefix=&lt;string&gt;
494 </dt>
495 <dd>
497 When creating files, prepend &lt;string&gt; (usually a directory
498 including a trailing /)
499 </p>
500 </dd>
501 <dt class="hdlist1">
502 --stage=&lt;number&gt;|all
503 </dt>
504 <dd>
506 Instead of checking out unmerged entries, copy out the
507 files from named stage. &lt;number&gt; must be between 1 and 3.
508 Note: --stage=all automatically implies --temp.
509 </p>
510 </dd>
511 <dt class="hdlist1">
512 --temp
513 </dt>
514 <dd>
516 Instead of copying the files to the working directory
517 write the content to temporary files. The temporary name
518 associations will be written to stdout.
519 </p>
520 </dd>
521 <dt class="hdlist1">
522 --stdin
523 </dt>
524 <dd>
526 Instead of taking list of paths from the command line,
527 read list of paths from the standard input. Paths are
528 separated by LF (i.e. one path per line) by default.
529 </p>
530 </dd>
531 <dt class="hdlist1">
533 </dt>
534 <dd>
536 Only meaningful with <tt>--stdin</tt>; paths are separated with
537 NUL character instead of LF.
538 </p>
539 </dd>
540 <dt class="hdlist1">
542 </dt>
543 <dd>
545 Do not interpret any more arguments as options.
546 </p>
547 </dd>
548 </dl></div>
549 <div class="paragraph"><p>The order of the flags used to matter, but not anymore.</p></div>
550 <div class="paragraph"><p>Just doing <tt>git checkout-index</tt> does nothing. You probably meant
551 <tt>git checkout-index -a</tt>. And if you want to force it, you want
552 <tt>git checkout-index -f -a</tt>.</p></div>
553 <div class="paragraph"><p>Intuitiveness is not the goal here. Repeatability is. The reason for
554 the "no arguments means no work" behavior is that from scripts you are
555 supposed to be able to do:</p></div>
556 <div class="listingblock">
557 <div class="content">
558 <pre><tt>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</tt></pre>
559 </div></div>
560 <div class="paragraph"><p>which will force all existing <tt>*.h</tt> files to be replaced with their
561 cached copies. If an empty command line implied "all", then this would
562 force-refresh everything in the index, which was not the point. But
563 since <em>git checkout-index</em> accepts --stdin it would be faster to use:</p></div>
564 <div class="listingblock">
565 <div class="content">
566 <pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</tt></pre>
567 </div></div>
568 <div class="paragraph"><p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;
569 it will prevent problems with a filename of, for example, <tt>-a</tt>.
570 Using <tt>--</tt> is probably a good policy in scripts.</p></div>
571 </div>
572 <h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2>
573 <div class="sectionbody">
574 <div class="paragraph"><p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)
575 <em>git checkout-index</em> will create a temporary file for each index
576 entry being checked out. The index will not be updated with stat
577 information. These options can be useful if the caller needs all
578 stages of all unmerged entries so that the unmerged files can be
579 processed by an external merge tool.</p></div>
580 <div class="paragraph"><p>A listing will be written to stdout providing the association of
581 temporary file names to tracked path names. The listing format
582 has two variations:</p></div>
583 <div class="olist arabic"><ol class="arabic">
584 <li>
586 tempname TAB path RS
587 </p>
588 <div class="paragraph"><p>The first format is what gets used when <tt>--stage</tt> is omitted or
589 is not <tt>--stage=all</tt>. The field tempname is the temporary file
590 name holding the file content and path is the tracked path name in
591 the index. Only the requested entries are output.</p></div>
592 </li>
593 <li>
595 stage1temp SP stage2temp SP stage3tmp TAB path RS
596 </p>
597 <div class="paragraph"><p>The second format is what gets used when <tt>--stage=all</tt>. The three
598 stage temporary fields (stage1temp, stage2temp, stage3temp) list the
599 name of the temporary file if there is a stage entry in the index
600 or <tt>.</tt> if there is no stage entry. Paths which only have a stage 0
601 entry will always be omitted from the output.</p></div>
602 </li>
603 </ol></div>
604 <div class="paragraph"><p>In both formats RS (the record separator) is newline by default
605 but will be the null byte if -z was passed on the command line.
606 The temporary file names are always safe strings; they will never
607 contain directory separators or whitespace characters. The path
608 field is always relative to the current directory and the temporary
609 file names are always relative to the top level directory.</p></div>
610 <div class="paragraph"><p>If the object being copied out to a temporary file is a symbolic
611 link the content of the link will be written to a normal file. It is
612 up to the end-user or the Porcelain to make use of this information.</p></div>
613 </div>
614 <h2 id="_examples">EXAMPLES</h2>
615 <div class="sectionbody">
616 <div class="dlist"><dl>
617 <dt class="hdlist1">
618 To update and refresh only the files already checked out
619 </dt>
620 <dd>
621 <div class="listingblock">
622 <div class="content">
623 <pre><tt>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</tt></pre>
624 </div></div>
625 </dd>
626 <dt class="hdlist1">
627 Using <em>git checkout-index</em> to "export an entire tree"
628 </dt>
629 <dd>
631 The prefix ability basically makes it trivial to use
632 <em>git checkout-index</em> as an "export as tree" function.
633 Just read the desired tree into the index, and do:
634 </p>
635 <div class="listingblock">
636 <div class="content">
637 <pre><tt>$ git checkout-index --prefix=git-export-dir/ -a</tt></pre>
638 </div></div>
639 <div class="paragraph"><p><tt>git checkout-index</tt> will "export" the index into the specified
640 directory.</p></div>
641 <div class="paragraph"><p>The final "/" is important. The exported name is literally just
642 prefixed with the specified string. Contrast this with the
643 following example.</p></div>
644 </dd>
645 <dt class="hdlist1">
646 Export files with a prefix
647 </dt>
648 <dd>
649 <div class="listingblock">
650 <div class="content">
651 <pre><tt>$ git checkout-index --prefix=.merged- Makefile</tt></pre>
652 </div></div>
653 <div class="paragraph"><p>This will check out the currently cached copy of <tt>Makefile</tt>
654 into the file <tt>.merged-Makefile</tt>.</p></div>
655 </dd>
656 </dl></div>
657 </div>
658 <h2 id="_git">GIT</h2>
659 <div class="sectionbody">
660 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
661 </div>
662 <div id="footer">
663 <div id="footer-text">
664 Last updated 2011-03-15 23:30:13 UTC
665 </div>
666 </div>
667 </body>
668 </html>