Google Git
Sign in
chromium / external / gitster / git-htmldocs / fbe7486629ec9aeeb001819e3a4b9fb7b756b3e6 / . / git-ls-files.html
blob: b5b639872b6d39890a225311facf16e2b2fe9a34 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]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" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-ls-files(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, 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;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#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;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194
195div.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;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
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;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#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;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
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.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
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);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
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);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
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);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: 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;
547 }
548 }
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>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-ls-files(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-ls-files -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]578 Show information about files in the index and the working tree
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]586<div class="verseblock-content"><em>git ls-files</em> [-z] [-t] [-v]
587 (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
588 (-[c|d|o|i|s|u|k|m])*
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]589 [-x &lt;pattern&gt;|--exclude=&lt;pattern&gt;]
590 [-X &lt;file&gt;|--exclude-from=&lt;file&gt;]
591 [--exclude-per-directory=&lt;file&gt;]
Junio C Hamanoff979792007-11-16 10:11:30[diff] [blame]592 [--exclude-standard]
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]593 [--error-unmatch] [--with-tree=&lt;tree-ish&gt;]
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]594 [--full-name] [--abbrev] [--] [&lt;file&gt;&#8230;]</div>
595<div class="verseblock-attribution">
596</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]597</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]598<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]599<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]600<div class="paragraph"><p>This merges the file listing in the directory cache index with the
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]601actual working directory list, and shows different combinations of the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]602two.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]603<div class="paragraph"><p>One or more of the options below may be used to determine the files
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]604shown:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]605</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]606<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]607<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]608<div class="dlist"><dl>
609<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]610-c
611</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]612<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]613--cached
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]614</dt>
615<dd>
616<p>
617 Show cached files in the output (default)
618</p>
619</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]620<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]621-d
622</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]623<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]624--deleted
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]625</dt>
626<dd>
627<p>
628 Show deleted files in the output
629</p>
630</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]631<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]632-m
633</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]634<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]635--modified
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]636</dt>
637<dd>
638<p>
639 Show modified files in the output
640</p>
641</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]642<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]643-o
644</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]645<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]646--others
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]647</dt>
648<dd>
649<p>
Junio C Hamano31cca162009-08-07 05:40:01[diff] [blame]650 Show other (i.e. untracked) files in the output
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]651</p>
652</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]653<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]654-i
655</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]656<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]657--ignored
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]658</dt>
659<dd>
660<p>
Junio C Hamano446ed772009-11-10 22:02:20[diff] [blame]661 Show only ignored files in the output. When showing files in the
662 index, print only those matched by an exclude pattern. When
663 showing "other" files, show only those matched by an exclude
664 pattern.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]665</p>
666</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]667<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]668-s
669</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]670<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]671--stage
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]672</dt>
673<dd>
674<p>
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]675 Show staged contents' object name, mode bits and stage number in the output.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]676</p>
677</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]678<dt class="hdlist1">
Junio C Hamanoa6331a82006-01-22 07:50:33[diff] [blame]679--directory
680</dt>
681<dd>
682<p>
683 If a whole directory is classified as "other", show just its
684 name (with a trailing slash) and not its whole contents.
685</p>
686</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]687<dt class="hdlist1">
Junio C Hamanof02e09f2006-03-27 07:51:03[diff] [blame]688--no-empty-directory
689</dt>
690<dd>
691<p>
692 Do not list empty directories. Has no effect without --directory.
693</p>
694</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]695<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]696-u
697</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]698<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]699--unmerged
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]700</dt>
701<dd>
702<p>
703 Show unmerged files in the output (forces --stage)
704</p>
705</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]706<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]707-k
708</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]709<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]710--killed
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]711</dt>
712<dd>
713<p>
714 Show files on the filesystem that need to be removed due
715 to file/directory conflicts for checkout-index to
716 succeed.
717</p>
718</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]719<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]720-z
721</dt>
722<dd>
723<p>
724 \0 line termination on output.
725</p>
726</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]727<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]728-x &lt;pattern&gt;
729</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]730<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]731--exclude=&lt;pattern&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]732</dt>
733<dd>
734<p>
Junio C Hamanoac752fa2010-09-19 00:01:00[diff] [blame]735 Skip untracked files matching pattern.
736 Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
737 below for more information.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]738</p>
739</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]740<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]741-X &lt;file&gt;
742</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]743<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]744--exclude-from=&lt;file&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]745</dt>
746<dd>
747<p>
Junio C Hamanoac752fa2010-09-19 00:01:00[diff] [blame]748 Read exclude patterns from &lt;file&gt;; 1 per line.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]749</p>
750</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]751<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]752--exclude-per-directory=&lt;file&gt;
753</dt>
754<dd>
755<p>
Junio C Hamanoac752fa2010-09-19 00:01:00[diff] [blame]756 Read additional exclude patterns that apply only to the
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]757 directory and its subdirectories in &lt;file&gt;.
758</p>
759</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]760<dt class="hdlist1">
Junio C Hamanoff979792007-11-16 10:11:30[diff] [blame]761--exclude-standard
762</dt>
763<dd>
764<p>
765 Add the standard git exclusions: .git/info/exclude, .gitignore
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]766 in each directory, and the user&#8217;s global exclusion file.
Junio C Hamanoff979792007-11-16 10:11:30[diff] [blame]767</p>
768</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]769<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]770--error-unmatch
771</dt>
772<dd>
773<p>
774 If any &lt;file&gt; does not appear in the index, treat this as an
775 error (return 1).
776</p>
777</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]778<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]779--with-tree=&lt;tree-ish&gt;
780</dt>
781<dd>
782<p>
783 When using --error-unmatch to expand the user supplied
784 &lt;file&gt; (i.e. path pattern) arguments to paths, pretend
785 that paths which were removed in the index since the
786 named &lt;tree-ish&gt; are still present. Using this option
787 with <tt>-s</tt> or <tt>-u</tt> options does not make any sense.
788</p>
789</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]790<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]791-t
792</dt>
793<dd>
794<p>
Junio C Hamanoa9788762010-08-03 15:15:54[diff] [blame]795 This feature is semi-deprecated. For scripting purpose,
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]796 <a href="git-status.html">git-status(1)</a> <tt>--porcelain</tt> and
797 <a href="git-diff-files.html">git-diff-files(1)</a> <tt>--name-status</tt> are almost always
Junio C Hamanoa9788762010-08-03 15:15:54[diff] [blame]798 superior alternatives, and users should look at
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]799 <a href="git-status.html">git-status(1)</a> <tt>--short</tt> or <a href="git-diff.html">git-diff(1)</a>
Junio C Hamanoa9788762010-08-03 15:15:54[diff] [blame]800 <tt>--name-status</tt> for more user-friendly alternatives.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]801</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]802<div class="paragraph"><p>This option identifies the file status with the following tags (followed by
Junio C Hamanoa9788762010-08-03 15:15:54[diff] [blame]803a space) at the start of each line:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]804</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]805<dt class="hdlist1">
806H
807</dt>
808<dd>
809<p>
810cached
811</p>
812</dd>
813<dt class="hdlist1">
814S
815</dt>
816<dd>
817<p>
818skip-worktree
819</p>
820</dd>
821<dt class="hdlist1">
822M
823</dt>
824<dd>
825<p>
826unmerged
827</p>
828</dd>
829<dt class="hdlist1">
830R
831</dt>
832<dd>
833<p>
834removed/deleted
835</p>
836</dd>
837<dt class="hdlist1">
838C
839</dt>
840<dd>
841<p>
842modified/changed
843</p>
844</dd>
845<dt class="hdlist1">
846K
847</dt>
848<dd>
849<p>
850to be killed
851</p>
852</dd>
853<dt class="hdlist1">
854?
855</dt>
856<dd>
857<p>
858other
859</p>
860</dd>
861<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]862-v
863</dt>
864<dd>
865<p>
866 Similar to <tt>-t</tt>, but use lowercase letters for files
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]867 that are marked as <em>assume unchanged</em> (see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]868 <a href="git-update-index.html">git-update-index(1)</a>).
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]869</p>
870</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]871<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]872--full-name
873</dt>
874<dd>
875<p>
876 When run from a subdirectory, the command usually
877 outputs paths relative to the current directory. This
878 option forces paths to be output relative to the project
879 top directory.
880</p>
881</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]882<dt class="hdlist1">
Junio C Hamano5c3957e2006-03-28 00:28:01[diff] [blame]883--abbrev[=&lt;n&gt;]
884</dt>
885<dd>
886<p>
887 Instead of showing the full 40-byte hexadecimal object
Junio C Hamano6efe3022009-01-13 16:47:56[diff] [blame]888 lines, show only a partial prefix.
Junio C Hamano5c3957e2006-03-28 00:28:01[diff] [blame]889 Non default number of digits can be specified with --abbrev=&lt;n&gt;.
890</p>
891</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]892<dt class="hdlist1">
Junio C Hamanoa9788762010-08-03 15:15:54[diff] [blame]893--debug
894</dt>
895<dd>
896<p>
897 After each line that describes a file, add more data about its
898 cache entry. This is intended to show as much information as
899 possible for manual inspection; the exact format may change at
900 any time.
901</p>
902</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]903<dt class="hdlist1">
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]904--
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]905</dt>
906<dd>
907<p>
908 Do not interpret any more arguments as options.
909</p>
910</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]911<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]912&lt;file&gt;
913</dt>
914<dd>
915<p>
916 Files to show. If no files are given all files which match the other
917 specified criteria are shown.
918</p>
919</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]920</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]921</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]922<h2 id="_output">Output</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]923<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]924<div class="paragraph"><p><em>git ls-files</em> just outputs the filenames unless <em>--stage</em> is specified in
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]925which case it outputs:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]926<div class="literalblock">
927<div class="content">
928<pre><tt>[&lt;tag&gt; ]&lt;mode&gt; &lt;object&gt; &lt;stage&gt; &lt;file&gt;</tt></pre>
929</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]930<div class="paragraph"><p><em>git ls-files --unmerged</em> and <em>git ls-files --stage</em> can be used to examine
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]931detailed information on unmerged paths.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]932<div class="paragraph"><p>For an unmerged path, instead of recording a single mode/SHA1 pair,
Junio C Hamano36460982007-05-27 04:29:12[diff] [blame]933the index records up to three such pairs; one from tree O in stage
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9341, A in stage 2, and B in stage 3. This information can be used by
935the user (or the porcelain) to see what should eventually be recorded at the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]936path. (see <a href="git-read-tree.html">git-read-tree(1)</a> for more information on state)</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]937<div class="paragraph"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]938in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]939respectively.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]940</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]941<h2 id="_exclude_patterns">Exclude Patterns</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]942<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]943<div class="paragraph"><p><em>git ls-files</em> can use a list of "exclude patterns" when
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]944traversing the directory tree and finding files to show when the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]945flags --others or --ignored are specified. <a href="gitignore.html">gitignore(5)</a>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]946specifies the format of exclude patterns.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]947<div class="paragraph"><p>These exclude patterns come from these places, in order:</p></div>
948<div class="olist arabic"><ol class="arabic">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]949<li>
950<p>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]951The command line flag --exclude=&lt;pattern&gt; specifies a
952 single pattern. Patterns are ordered in the same order
953 they appear in the command line.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]954</p>
955</li>
956<li>
957<p>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]958The command line flag --exclude-from=&lt;file&gt; specifies a
959 file containing a list of patterns. Patterns are ordered
960 in the same order they appear in the file.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]961</p>
962</li>
963<li>
964<p>
Junio C Hamanoac752fa2010-09-19 00:01:00[diff] [blame]965The command line flag --exclude-per-directory=&lt;name&gt; specifies
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]966 a name of the file in each directory <em>git ls-files</em>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]967 examines, normally <tt>.gitignore</tt>. Files in deeper
968 directories take precedence. Patterns are ordered in the
969 same order they appear in the files.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]970</p>
971</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]972</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]973<div class="paragraph"><p>A pattern specified on the command line with --exclude or read
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]974from the file specified with --exclude-from is relative to the
975top of the directory tree. A pattern read from a file specified
976by --exclude-per-directory is relative to the directory that the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]977pattern file appears in.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]978</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]979<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]980<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]981<div class="paragraph"><p><a href="git-read-tree.html">git-read-tree(1)</a>, <a href="gitignore.html">gitignore(5)</a></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]982</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]983<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]984<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]985<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]986</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]987</div>
988<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]989<div id="footer">
990<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]991Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]992</div>
993</div>
994</body>
995</html>