git-ls-files.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-ls-files(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-ls-files(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-ls-files -
 743    Show information about files in the index and 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 ls-files</em> [-z] [-t] [-v] [-f]
 753                 [-c|--cached] [-d|--deleted] [-o|--others] [-i|--ignored]
 754                 [-s|--stage] [-u|--unmerged] [-k|--killed] [-m|--modified]
 755                 [--resolve-undo]
 756                 [--directory [--no-empty-directory]] [--eol]
 757                 [--deduplicate]
 758                 [-x &lt;pattern&gt;|--exclude=&lt;pattern&gt;]
 759                 [-X &lt;file&gt;|--exclude-from=&lt;file&gt;]
 760                 [--exclude-per-directory=&lt;file&gt;]
 761                 [--exclude-standard]
 762                 [--error-unmatch] [--with-tree=&lt;tree-ish&gt;]
 763                 [--full-name] [--recurse-submodules]
 764                 [--abbrev[=&lt;n&gt;]] [--format=&lt;format&gt;] [--] [&lt;file&gt;&#8230;]</pre>
 765 <div class="attribution">
 766 </div></div>
 767 </div>
 768 </div>
 769 <div class="sect1">
 770 <h2 id="_description">DESCRIPTION</h2>
 771 <div class="sectionbody">
 772 <div class="paragraph"><p>This command merges the file listing in the index with the actual working
 773 directory list, and shows different combinations of the two.</p></div>
 774 <div class="paragraph"><p>Several flags can be used to determine which files are
 775 shown, and each file may be printed multiple times if there are
 776 multiple entries in the index or if multiple statuses are applicable for
 777 the relevant file selection options.</p></div>
 778 </div>
 779 </div>
 780 <div class="sect1">
 781 <h2 id="_options">OPTIONS</h2>
 782 <div class="sectionbody">
 783 <div class="dlist"><dl>
 784 <dt class="hdlist1">
 785 -c
 786 </dt>
 787 <dt class="hdlist1">
 788 --cached
 789 </dt>
 790 <dd>
 791 <p>
 792         Show all files cached in Git&#8217;s index, i.e. all tracked files.
 793         (This is the default if no -c/-s/-d/-o/-u/-k/-m/--resolve-undo
 794         options are specified.)
 795 </p>
 796 </dd>
 797 <dt class="hdlist1">
 798 -d
 799 </dt>
 800 <dt class="hdlist1">
 801 --deleted
 802 </dt>
 803 <dd>
 804 <p>
 805         Show files with an unstaged deletion
 806 </p>
 807 </dd>
 808 <dt class="hdlist1">
 809 -m
 810 </dt>
 811 <dt class="hdlist1">
 812 --modified
 813 </dt>
 814 <dd>
 815 <p>
 816         Show files with an unstaged modification (note that an unstaged
 817         deletion also counts as an unstaged modification)
 818 </p>
 819 </dd>
 820 <dt class="hdlist1">
 821 -o
 822 </dt>
 823 <dt class="hdlist1">
 824 --others
 825 </dt>
 826 <dd>
 827 <p>
 828         Show other (i.e. untracked) files in the output
 829 </p>
 830 </dd>
 831 <dt class="hdlist1">
 832 -i
 833 </dt>
 834 <dt class="hdlist1">
 835 --ignored
 836 </dt>
 837 <dd>
 838 <p>
 839         Show only ignored files in the output.  Must be used with
 840         either an explicit <em>-c</em> or <em>-o</em>.  When showing files in the
 841         index (i.e. when used with <em>-c</em>), print only those files
 842         matching an exclude pattern.  When showing "other" files
 843         (i.e. when used with <em>-o</em>), show only those matched by an
 844         exclude pattern.  Standard ignore rules are not automatically
 845         activated; therefore, at least one of the <code>--exclude*</code> options
 846         is required.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 -s
 851 </dt>
 852 <dt class="hdlist1">
 853 --stage
 854 </dt>
 855 <dd>
 856 <p>
 857         Show staged contents' mode bits, object name and stage number in the output.
 858 </p>
 859 </dd>
 860 <dt class="hdlist1">
 861 --directory
 862 </dt>
 863 <dd>
 864 <p>
 865         If a whole directory is classified as "other", show just its
 866         name (with a trailing slash) and not its whole contents.
 867         Has no effect without -o/--others.
 868 </p>
 869 </dd>
 870 <dt class="hdlist1">
 871 --no-empty-directory
 872 </dt>
 873 <dd>
 874 <p>
 875         Do not list empty directories. Has no effect without --directory.
 876 </p>
 877 </dd>
 878 <dt class="hdlist1">
 879 -u
 880 </dt>
 881 <dt class="hdlist1">
 882 --unmerged
 883 </dt>
 884 <dd>
 885 <p>
 886         Show information about unmerged files in the output, but do
 887         not show any other tracked files (forces --stage, overrides
 888         --cached).
 889 </p>
 890 </dd>
 891 <dt class="hdlist1">
 892 -k
 893 </dt>
 894 <dt class="hdlist1">
 895 --killed
 896 </dt>
 897 <dd>
 898 <p>
 899         Show untracked files on the filesystem that need to be removed
 900         due to file/directory conflicts for tracked files to be able to
 901         be written to the filesystem.
 902 </p>
 903 </dd>
 904 <dt class="hdlist1">
 905 --resolve-undo
 906 </dt>
 907 <dd>
 908 <p>
 909         Show files having resolve-undo information in the index
 910         together with their resolve-undo information.  (resolve-undo
 911         information is what is used to implement "git checkout -m
 912         $PATH", i.e. to recreate merge conflicts that were
 913         accidentally resolved)
 914 </p>
 915 </dd>
 916 <dt class="hdlist1">
 917 -z
 918 </dt>
 919 <dd>
 920 <p>
 921         \0 line termination on output and do not quote filenames.
 922         See OUTPUT below for more information.
 923 </p>
 924 </dd>
 925 <dt class="hdlist1">
 926 --deduplicate
 927 </dt>
 928 <dd>
 929 <p>
 930         When only filenames are shown, suppress duplicates that may
 931         come from having multiple stages during a merge, or giving
 932         <code>--deleted</code> and <code>--modified</code> option at the same time.
 933         When any of the <code>-t</code>, <code>--unmerged</code>, or <code>--stage</code> option is
 934         in use, this option has no effect.
 935 </p>
 936 </dd>
 937 <dt class="hdlist1">
 938 -x &lt;pattern&gt;
 939 </dt>
 940 <dt class="hdlist1">
 941 --exclude=&lt;pattern&gt;
 942 </dt>
 943 <dd>
 944 <p>
 945         Skip untracked files matching pattern.
 946         Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
 947         below for more information.
 948 </p>
 949 </dd>
 950 <dt class="hdlist1">
 951 -X &lt;file&gt;
 952 </dt>
 953 <dt class="hdlist1">
 954 --exclude-from=&lt;file&gt;
 955 </dt>
 956 <dd>
 957 <p>
 958         Read exclude patterns from &lt;file&gt;; 1 per line.
 959 </p>
 960 </dd>
 961 <dt class="hdlist1">
 962 --exclude-per-directory=&lt;file&gt;
 963 </dt>
 964 <dd>
 965 <p>
 966         Read additional exclude patterns that apply only to the
 967         directory and its subdirectories in &lt;file&gt;.  If you are
 968         trying to emulate the way Porcelain commands work, using
 969         the <code>--exclude-standard</code> option instead is easier and more
 970         thorough.
 971 </p>
 972 </dd>
 973 <dt class="hdlist1">
 974 --exclude-standard
 975 </dt>
 976 <dd>
 977 <p>
 978         Add the standard Git exclusions: .git/info/exclude, .gitignore
 979         in each directory, and the user&#8217;s global exclusion file.
 980 </p>
 981 </dd>
 982 <dt class="hdlist1">
 983 --error-unmatch
 984 </dt>
 985 <dd>
 986 <p>
 987         If any &lt;file&gt; does not appear in the index, treat this as an
 988         error (return 1).
 989 </p>
 990 </dd>
 991 <dt class="hdlist1">
 992 --with-tree=&lt;tree-ish&gt;
 993 </dt>
 994 <dd>
 995 <p>
 996         When using --error-unmatch to expand the user supplied
 997         &lt;file&gt; (i.e. path pattern) arguments to paths, pretend
 998         that paths which were removed in the index since the
 999         named &lt;tree-ish&gt; are still present.  Using this option
1000         with <code>-s</code> or <code>-u</code> options does not make any sense.
1001 </p>
1002 </dd>
1003 <dt class="hdlist1">
1004 -t
1005 </dt>
1006 <dd>
1007 <p>
1008         Show status tags together with filenames.  Note that for
1009         scripting purposes, <a href="git-status.html">git-status(1)</a> <code>--porcelain</code> and
1010         <a href="git-diff-files.html">git-diff-files(1)</a> <code>--name-status</code> are almost always
1011         superior alternatives; users should look at
1012         <a href="git-status.html">git-status(1)</a> <code>--short</code> or <a href="git-diff.html">git-diff(1)</a>
1013         <code>--name-status</code> for more user-friendly alternatives.
1014 </p>
1015 <div class="openblock">
1016 <div class="content">
1017 <div class="paragraph"><p>This option provides a reason for showing each filename, in the form
1018 of a status tag (which is followed by a space and then the filename).
1019 The status tags are all single characters from the following list:</p></div>
1020 <div class="dlist"><dl>
1021 <dt class="hdlist1">
1022 H
1023 </dt>
1024 <dd>
1025 <p>
1026 tracked file that is not either unmerged or skip-worktree
1027 </p>
1028 </dd>
1029 <dt class="hdlist1">
1030 S
1031 </dt>
1032 <dd>
1033 <p>
1034 tracked file that is skip-worktree
1035 </p>
1036 </dd>
1037 <dt class="hdlist1">
1038 M
1039 </dt>
1040 <dd>
1041 <p>
1042 tracked file that is unmerged
1043 </p>
1044 </dd>
1045 <dt class="hdlist1">
1046 R
1047 </dt>
1048 <dd>
1049 <p>
1050 tracked file with unstaged removal/deletion
1051 </p>
1052 </dd>
1053 <dt class="hdlist1">
1054 C
1055 </dt>
1056 <dd>
1057 <p>
1058 tracked file with unstaged modification/change
1059 </p>
1060 </dd>
1061 <dt class="hdlist1">
1062 K
1063 </dt>
1064 <dd>
1065 <p>
1066 untracked paths which are part of file/directory conflicts
1067                 which prevent checking out tracked files
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 ?
1072 </dt>
1073 <dd>
1074 <p>
1075 untracked file
1076 </p>
1077 </dd>
1078 <dt class="hdlist1">
1079 U
1080 </dt>
1081 <dd>
1082 <p>
1083 file with resolve-undo information
1084 </p>
1085 </dd>
1086 </dl></div>
1087 </div></div>
1088 </dd>
1089 <dt class="hdlist1">
1090 -v
1091 </dt>
1092 <dd>
1093 <p>
1094         Similar to <code>-t</code>, but use lowercase letters for files
1095         that are marked as <em>assume unchanged</em> (see
1096         <a href="git-update-index.html">git-update-index(1)</a>).
1097 </p>
1098 </dd>
1099 <dt class="hdlist1">
1100 -f
1101 </dt>
1102 <dd>
1103 <p>
1104         Similar to <code>-t</code>, but use lowercase letters for files
1105         that are marked as <em>fsmonitor valid</em> (see
1106         <a href="git-update-index.html">git-update-index(1)</a>).
1107 </p>
1108 </dd>
1109 <dt class="hdlist1">
1110 --full-name
1111 </dt>
1112 <dd>
1113 <p>
1114         When run from a subdirectory, the command usually
1115         outputs paths relative to the current directory.  This
1116         option forces paths to be output relative to the project
1117         top directory.
1118 </p>
1119 </dd>
1120 <dt class="hdlist1">
1121 --recurse-submodules
1122 </dt>
1123 <dd>
1124 <p>
1125         Recursively calls ls-files on each active submodule in the repository.
1126         Currently there is only support for the --cached and --stage modes.
1127 </p>
1128 </dd>
1129 <dt class="hdlist1">
1130 --abbrev[=&lt;n&gt;]
1131 </dt>
1132 <dd>
1133 <p>
1134         Instead of showing the full 40-byte hexadecimal object
1135         lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
1136         hexdigits long that uniquely refers the object.
1137         Non default number of digits can be specified with --abbrev=&lt;n&gt;.
1138 </p>
1139 </dd>
1140 <dt class="hdlist1">
1141 --debug
1142 </dt>
1143 <dd>
1144 <p>
1145         After each line that describes a file, add more data about its
1146         cache entry.  This is intended to show as much information as
1147         possible for manual inspection; the exact format may change at
1148         any time.
1149 </p>
1150 </dd>
1151 <dt class="hdlist1">
1152 --eol
1153 </dt>
1154 <dd>
1155 <p>
1156         Show &lt;eolinfo&gt; and &lt;eolattr&gt; of files.
1157         &lt;eolinfo&gt; is the file content identification used by Git when
1158         the "text" attribute is "auto" (or not set and core.autocrlf is not false).
1159         &lt;eolinfo&gt; is either "-text", "none", "lf", "crlf", "mixed" or "".
1160 </p>
1161 <div class="paragraph"><p>"" means the file is not a regular file, it is not in the index or
1162 not accessible in the working tree.</p></div>
1163 <div class="paragraph"><p>&lt;eolattr&gt; is the attribute that is used when checking out or committing,
1164 it is either "", "-text", "text", "text=auto", "text eol=lf", "text eol=crlf".
1165 Since Git 2.10 "text=auto eol=lf" and "text=auto eol=crlf" are supported.</p></div>
1166 <div class="paragraph"><p>Both the &lt;eolinfo&gt; in the index ("i/&lt;eolinfo&gt;")
1167 and in the working tree ("w/&lt;eolinfo&gt;") are shown for regular files,
1168 followed by the  ("attr/&lt;eolattr&gt;").</p></div>
1169 </dd>
1170 <dt class="hdlist1">
1171 --sparse
1172 </dt>
1173 <dd>
1174 <p>
1175         If the index is sparse, show the sparse directories without expanding
1176         to the contained files. Sparse directories will be shown with a
1177         trailing slash, such as "x/" for a sparse directory "x".
1178 </p>
1179 </dd>
1180 <dt class="hdlist1">
1181 --format=&lt;format&gt;
1182 </dt>
1183 <dd>
1184 <p>
1185         A string that interpolates <code>%(fieldname)</code> from the result being shown.
1186         It also interpolates <code>%%</code> to <code>%</code>, and <code>%xx</code> where <code>xx</code> are hex digits
1187         interpolates to character with hex code <code>xx</code>; for example <code>%00</code>
1188         interpolates to <code>\0</code> (NUL), <code>%09</code> to <code>\t</code> (TAB) and %0a to <code>\n</code> (LF).
1189         --format cannot be combined with <code>-s</code>, <code>-o</code>, <code>-k</code>, <code>-t</code>, <code>--resolve-undo</code>
1190         and <code>--eol</code>.
1191 </p>
1192 </dd>
1193 <dt class="hdlist1">
1194 --
1195 </dt>
1196 <dd>
1197 <p>
1198         Do not interpret any more arguments as options.
1199 </p>
1200 </dd>
1201 <dt class="hdlist1">
1202 &lt;file&gt;
1203 </dt>
1204 <dd>
1205 <p>
1206         Files to show. If no files are given all files which match the other
1207         specified criteria are shown.
1208 </p>
1209 </dd>
1210 </dl></div>
1211 </div>
1212 </div>
1213 <div class="sect1">
1214 <h2 id="_output">OUTPUT</h2>
1215 <div class="sectionbody">
1216 <div class="paragraph"><p><em>git ls-files</em> just outputs the filenames unless <code>--stage</code> is specified in
1217 which case it outputs:</p></div>
1218 <div class="literalblock">
1219 <div class="content">
1220 <pre><code>[&lt;tag&gt; ]&lt;mode&gt; &lt;object&gt; &lt;stage&gt; &lt;file&gt;</code></pre>
1221 </div></div>
1222 <div class="paragraph"><p><em>git ls-files --eol</em> will show
1223         i/&lt;eolinfo&gt;&lt;SPACES&gt;w/&lt;eolinfo&gt;&lt;SPACES&gt;attr/&lt;eolattr&gt;&lt;SPACE*&gt;&lt;TAB&gt;&lt;file&gt;</p></div>
1224 <div class="paragraph"><p><em>git ls-files --unmerged</em> and <em>git ls-files --stage</em> can be used to examine
1225 detailed information on unmerged paths.</p></div>
1226 <div class="paragraph"><p>For an unmerged path, instead of recording a single mode/SHA-1 pair,
1227 the index records up to three such pairs; one from tree O in stage
1228 1, A in stage 2, and B in stage 3.  This information can be used by
1229 the user (or the porcelain) to see what should eventually be recorded at the
1230 path. (see <a href="git-read-tree.html">git-read-tree(1)</a> for more information on state)</p></div>
1231 <div class="paragraph"><p>Without the <code>-z</code> option, pathnames with "unusual" characters are
1232 quoted as explained for the configuration variable <code>core.quotePath</code>
1233 (see <a href="git-config.html">git-config(1)</a>).  Using <code>-z</code> the filename is output
1234 verbatim and the line is terminated by a NUL byte.</p></div>
1235 <div class="paragraph"><p>It is possible to print in a custom format by using the <code>--format</code>
1236 option, which is able to interpolate different fields using
1237 a <code>%(fieldname)</code> notation. For example, if you only care about the
1238 "objectname" and "path" fields, you can execute with a specific
1239 "--format" like</p></div>
1240 <div class="literalblock">
1241 <div class="content">
1242 <pre><code>git ls-files --format='%(objectname) %(path)'</code></pre>
1243 </div></div>
1244 </div>
1245 </div>
1246 <div class="sect1">
1247 <h2 id="_field_names">FIELD NAMES</h2>
1248 <div class="sectionbody">
1249 <div class="paragraph"><p>The way each path is shown can be customized by using the
1250 <code>--format=&lt;format&gt;</code> option, where the %(fieldname) in the
1251 &lt;format&gt; string for various aspects of the index entry are
1252 interpolated.  The following "fieldname" are understood:</p></div>
1253 <div class="dlist"><dl>
1254 <dt class="hdlist1">
1255 objectmode
1256 </dt>
1257 <dd>
1258 <p>
1259         The mode of the file which is recorded in the index.
1260 </p>
1261 </dd>
1262 <dt class="hdlist1">
1263 objecttype
1264 </dt>
1265 <dd>
1266 <p>
1267         The object type of the file which is recorded in the index.
1268 </p>
1269 </dd>
1270 <dt class="hdlist1">
1271 objectname
1272 </dt>
1273 <dd>
1274 <p>
1275         The name of the file which is recorded in the index.
1276 </p>
1277 </dd>
1278 <dt class="hdlist1">
1279 objectsize[:padded]
1280 </dt>
1281 <dd>
1282 <p>
1283         The object size of the file which is recorded in the index
1284         ("-" if the object is a <code>commit</code> or <code>tree</code>).
1285         It also supports a padded format of size with "%(objectsize:padded)".
1286 </p>
1287 </dd>
1288 <dt class="hdlist1">
1289 stage
1290 </dt>
1291 <dd>
1292 <p>
1293         The stage of the file which is recorded in the index.
1294 </p>
1295 </dd>
1296 <dt class="hdlist1">
1297 eolinfo:index
1298 </dt>
1299 <dt class="hdlist1">
1300 eolinfo:worktree
1301 </dt>
1302 <dd>
1303 <p>
1304         The &lt;eolinfo&gt; (see the description of the <code>--eol</code> option) of
1305         the contents in the index or in the worktree for the path.
1306 </p>
1307 </dd>
1308 <dt class="hdlist1">
1309 eolattr
1310 </dt>
1311 <dd>
1312 <p>
1313         The &lt;eolattr&gt; (see the description of the <code>--eol</code> option)
1314         that applies to the path.
1315 </p>
1316 </dd>
1317 <dt class="hdlist1">
1318 path
1319 </dt>
1320 <dd>
1321 <p>
1322         The pathname of the file which is recorded in the index.
1323 </p>
1324 </dd>
1325 </dl></div>
1326 </div>
1327 </div>
1328 <div class="sect1">
1329 <h2 id="_exclude_patterns">EXCLUDE PATTERNS</h2>
1330 <div class="sectionbody">
1331 <div class="paragraph"><p><em>git ls-files</em> can use a list of "exclude patterns" when
1332 traversing the directory tree and finding files to show when the
1333 flags --others or --ignored are specified.  <a href="gitignore.html">gitignore(5)</a>
1334 specifies the format of exclude patterns.</p></div>
1335 <div class="paragraph"><p>These exclude patterns can be specified from the following places,
1336 in order:</p></div>
1337 <div class="olist arabic"><ol class="arabic">
1338 <li>
1339 <p>
1340 The command-line flag --exclude=&lt;pattern&gt; specifies a
1341      single pattern.  Patterns are ordered in the same order
1342      they appear in the command line.
1343 </p>
1344 </li>
1345 <li>
1346 <p>
1347 The command-line flag --exclude-from=&lt;file&gt; specifies a
1348      file containing a list of patterns.  Patterns are ordered
1349      in the same order they appear in the file.
1350 </p>
1351 </li>
1352 <li>
1353 <p>
1354 The command-line flag --exclude-per-directory=&lt;name&gt; specifies
1355      a name of the file in each directory <em>git ls-files</em>
1356      examines, normally <code>.gitignore</code>.  Files in deeper
1357      directories take precedence.  Patterns are ordered in the
1358      same order they appear in the files.
1359 </p>
1360 </li>
1361 </ol></div>
1362 <div class="paragraph"><p>A pattern specified on the command line with --exclude or read
1363 from the file specified with --exclude-from is relative to the
1364 top of the directory tree.  A pattern read from a file specified
1365 by --exclude-per-directory is relative to the directory that the
1366 pattern file appears in.</p></div>
1367 <div class="paragraph"><p>Generally, you should be able to use <code>--exclude-standard</code> when you
1368 want the exclude rules applied the same way as what Porcelain
1369 commands do.  To emulate what <code>--exclude-standard</code> specifies, you
1370 can give <code>--exclude-per-directory=.gitignore</code>, and then specify:</p></div>
1371 <div class="olist arabic"><ol class="arabic">
1372 <li>
1373 <p>
1374 The file specified by the <code>core.excludesfile</code> configuration
1375      variable, if exists, or the <code>$XDG_CONFIG_HOME/git/ignore</code> file.
1376 </p>
1377 </li>
1378 <li>
1379 <p>
1380 The <code>$GIT_DIR/info/exclude</code> file.
1381 </p>
1382 </li>
1383 </ol></div>
1384 <div class="paragraph"><p>via the <code>--exclude-from=</code> option.</p></div>
1385 </div>
1386 </div>
1387 <div class="sect1">
1388 <h2 id="_see_also">SEE ALSO</h2>
1389 <div class="sectionbody">
1390 <div class="paragraph"><p><a href="git-read-tree.html">git-read-tree(1)</a>, <a href="gitignore.html">gitignore(5)</a></p></div>
1391 </div>
1392 </div>
1393 <div class="sect1">
1394 <h2 id="_git">GIT</h2>
1395 <div class="sectionbody">
1396 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1397 </div>
1398 </div>
1399 </div>
1400 <div id="footnotes"><hr /></div>
1401 <div id="footer">
1402 <div id="footer-text">
1403 Last updated
1404  2024-02-02 14:30:49 PST
1405 </div>
1406 </div>
1407 </body>
1408 </html>