git-rm.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-rm(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-rm(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-rm -
 743    Remove files from the working tree and from the index
 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 rm</em> [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch]
 753           [--quiet] [--pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]]
 754           [--] [&lt;pathspec&gt;&#8230;]</pre>
 755 <div class="attribution">
 756 </div></div>
 757 </div>
 758 </div>
 759 <div class="sect1">
 760 <h2 id="_description">DESCRIPTION</h2>
 761 <div class="sectionbody">
 762 <div class="paragraph"><p>Remove files matching pathspec from the index, or from the working tree
 763 and the index. <code>git rm</code> will not remove a file from just your working
 764 directory. (There is no option to remove a file only from the working
 765 tree and yet keep it in the index; use <code>/bin/rm</code> if you want to do
 766 that.) The files being removed have to be identical to the tip of the
 767 branch, and no updates to their contents can be staged in the index,
 768 though that default behavior can be overridden with the <code>-f</code> option.
 769 When <code>--cached</code> is given, the staged content has to
 770 match either the tip of the branch or the file on disk,
 771 allowing the file to be removed from just the index. When
 772 sparse-checkouts are in use (see <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>),
 773 <code>git rm</code> will only remove paths within the sparse-checkout patterns.</p></div>
 774 </div>
 775 </div>
 776 <div class="sect1">
 777 <h2 id="_options">OPTIONS</h2>
 778 <div class="sectionbody">
 779 <div class="dlist"><dl>
 780 <dt class="hdlist1">
 781 &lt;pathspec&gt;&#8230;
 782 </dt>
 783 <dd>
 784 <p>
 785         Files to remove.  A leading directory name (e.g. <code>dir</code> to remove
 786         <code>dir/file1</code> and <code>dir/file2</code>) can be given to remove all files in
 787         the directory, and recursively all sub-directories, but this
 788         requires the <code>-r</code> option to be explicitly given.
 789 </p>
 790 <div class="paragraph"><p>The command removes only the paths that are known to Git.</p></div>
 791 <div class="paragraph"><p>File globbing matches across directory boundaries.  Thus, given two
 792 directories <code>d</code> and <code>d2</code>, there is a difference between using
 793 <code>git rm 'd*'</code> and <code>git rm 'd/*'</code>, as the former will also remove all
 794 of directory <code>d2</code>.</p></div>
 795 <div class="paragraph"><p>For more details, see the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
 796 </dd>
 797 <dt class="hdlist1">
 798 -f
 799 </dt>
 800 <dt class="hdlist1">
 801 --force
 802 </dt>
 803 <dd>
 804 <p>
 805         Override the up-to-date check.
 806 </p>
 807 </dd>
 808 <dt class="hdlist1">
 809 -n
 810 </dt>
 811 <dt class="hdlist1">
 812 --dry-run
 813 </dt>
 814 <dd>
 815 <p>
 816         Don&#8217;t actually remove any file(s).  Instead, just show
 817         if they exist in the index and would otherwise be removed
 818         by the command.
 819 </p>
 820 </dd>
 821 <dt class="hdlist1">
 822 -r
 823 </dt>
 824 <dd>
 825 <p>
 826         Allow recursive removal when a leading directory name is
 827         given.
 828 </p>
 829 </dd>
 830 <dt class="hdlist1">
 831 --
 832 </dt>
 833 <dd>
 834 <p>
 835         This option can be used to separate command-line options from
 836         the list of files, (useful when filenames might be mistaken
 837         for command-line options).
 838 </p>
 839 </dd>
 840 <dt class="hdlist1">
 841 --cached
 842 </dt>
 843 <dd>
 844 <p>
 845         Use this option to unstage and remove paths only from the index.
 846         Working tree files, whether modified or not, will be
 847         left alone.
 848 </p>
 849 </dd>
 850 <dt class="hdlist1">
 851 --ignore-unmatch
 852 </dt>
 853 <dd>
 854 <p>
 855         Exit with a zero status even if no files matched.
 856 </p>
 857 </dd>
 858 <dt class="hdlist1">
 859 --sparse
 860 </dt>
 861 <dd>
 862 <p>
 863         Allow updating index entries outside of the sparse-checkout cone.
 864         Normally, <code>git rm</code> refuses to update index entries whose paths do
 865         not fit within the sparse-checkout cone. See
 866         <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more.
 867 </p>
 868 </dd>
 869 <dt class="hdlist1">
 870 -q
 871 </dt>
 872 <dt class="hdlist1">
 873 --quiet
 874 </dt>
 875 <dd>
 876 <p>
 877         <code>git rm</code> normally outputs one line (in the form of an <code>rm</code> command)
 878         for each file removed. This option suppresses that output.
 879 </p>
 880 </dd>
 881 <dt class="hdlist1">
 882 --pathspec-from-file=&lt;file&gt;
 883 </dt>
 884 <dd>
 885 <p>
 886         Pathspec is passed in <code>&lt;file&gt;</code> instead of commandline args. If
 887         <code>&lt;file&gt;</code> is exactly <code>-</code> then standard input is used. Pathspec
 888         elements are separated by LF or CR/LF. Pathspec elements can be
 889         quoted as explained for the configuration variable <code>core.quotePath</code>
 890         (see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
 891         global <code>--literal-pathspecs</code>.
 892 </p>
 893 </dd>
 894 <dt class="hdlist1">
 895 --pathspec-file-nul
 896 </dt>
 897 <dd>
 898 <p>
 899         Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
 900         separated with NUL character and all other characters are taken
 901         literally (including newlines and quotes).
 902 </p>
 903 </dd>
 904 </dl></div>
 905 </div>
 906 </div>
 907 <div class="sect1">
 908 <h2 id="_removing_files_that_have_disappeared_from_the_filesystem">REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM</h2>
 909 <div class="sectionbody">
 910 <div class="paragraph"><p>There is no option for <code>git rm</code> to remove from the index only
 911 the paths that have disappeared from the filesystem. However,
 912 depending on the use case, there are several ways that can be
 913 done.</p></div>
 914 <div class="sect2">
 915 <h3 id="_using_8220_git_commit_a_8221">Using &#8220;git commit -a&#8221;</h3>
 916 <div class="paragraph"><p>If you intend that your next commit should record all modifications
 917 of tracked files in the working tree and record all removals of
 918 files that have been removed from the working tree with <code>rm</code>
 919 (as opposed to <code>git rm</code>), use <code>git commit -a</code>, as it will
 920 automatically notice and record all removals.  You can also have a
 921 similar effect without committing by using <code>git add -u</code>.</p></div>
 922 </div>
 923 <div class="sect2">
 924 <h3 id="_using_8220_git_add_a_8221">Using &#8220;git add -A&#8221;</h3>
 925 <div class="paragraph"><p>When accepting a new code drop for a vendor branch, you probably
 926 want to record both the removal of paths and additions of new paths
 927 as well as modifications of existing paths.</p></div>
 928 <div class="paragraph"><p>Typically you would first remove all tracked files from the working
 929 tree using this command:</p></div>
 930 <div class="listingblock">
 931 <div class="content">
 932 <pre><code>git ls-files -z | xargs -0 rm -f</code></pre>
 933 </div></div>
 934 <div class="paragraph"><p>and then untar the new code in the working tree. Alternately
 935 you could <em>rsync</em> the changes into the working tree.</p></div>
 936 <div class="paragraph"><p>After that, the easiest way to record all removals, additions, and
 937 modifications in the working tree is:</p></div>
 938 <div class="listingblock">
 939 <div class="content">
 940 <pre><code>git add -A</code></pre>
 941 </div></div>
 942 <div class="paragraph"><p>See <a href="git-add.html">git-add(1)</a>.</p></div>
 943 </div>
 944 <div class="sect2">
 945 <h3 id="_other_ways">Other ways</h3>
 946 <div class="paragraph"><p>If all you really want to do is to remove from the index the files
 947 that are no longer present in the working tree (perhaps because
 948 your working tree is dirty so that you cannot use <code>git commit -a</code>),
 949 use the following command:</p></div>
 950 <div class="listingblock">
 951 <div class="content">
 952 <pre><code>git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached</code></pre>
 953 </div></div>
 954 </div>
 955 </div>
 956 </div>
 957 <div class="sect1">
 958 <h2 id="_submodules">SUBMODULES</h2>
 959 <div class="sectionbody">
 960 <div class="paragraph"><p>Only submodules using a gitfile (which means they were cloned
 961 with a Git version 1.7.8 or newer) will be removed from the work
 962 tree, as their repository lives inside the .git directory of the
 963 superproject. If a submodule (or one of those nested inside it)
 964 still uses a .git directory, <code>git rm</code> will move the submodules
 965 git directory into the superprojects git directory to protect
 966 the submodule&#8217;s history. If it exists the submodule.&lt;name&gt; section
 967 in the <a href="gitmodules.html">gitmodules(5)</a> file will also be removed and that file
 968 will be staged (unless --cached or -n are used).</p></div>
 969 <div class="paragraph"><p>A submodule is considered up to date when the HEAD is the same as
 970 recorded in the index, no tracked files are modified and no untracked
 971 files that aren&#8217;t ignored are present in the submodule&#8217;s work tree.
 972 Ignored files are deemed expendable and won&#8217;t stop a submodule&#8217;s work
 973 tree from being removed.</p></div>
 974 <div class="paragraph"><p>If you only want to remove the local checkout of a submodule from your
 975 work tree without committing the removal, use <a href="git-submodule.html">git-submodule(1)</a> <code>deinit</code>
 976 instead. Also see <a href="gitsubmodules.html">gitsubmodules(7)</a> for details on submodule removal.</p></div>
 977 </div>
 978 </div>
 979 <div class="sect1">
 980 <h2 id="_examples">EXAMPLES</h2>
 981 <div class="sectionbody">
 982 <div class="dlist"><dl>
 983 <dt class="hdlist1">
 984 <code>git rm Documentation/\*.txt</code>
 985 </dt>
 986 <dd>
 987 <p>
 988         Removes all <code>*.txt</code> files from the index that are under the
 989         <code>Documentation</code> directory and any of its subdirectories.
 990 </p>
 991 <div class="paragraph"><p>Note that the asterisk <code>*</code> is quoted from the shell in this
 992 example; this lets Git, and not the shell, expand the pathnames
 993 of files and subdirectories under the <code>Documentation/</code> directory.</p></div>
 994 </dd>
 995 <dt class="hdlist1">
 996 <code>git rm -f git-*.sh</code>
 997 </dt>
 998 <dd>
 999 <p>
1000         Because this example lets the shell expand the asterisk
1001         (i.e. you are listing the files explicitly), it
1002         does not remove <code>subdir/git-foo.sh</code>.
1003 </p>
1004 </dd>
1005 </dl></div>
1006 </div>
1007 </div>
1008 <div class="sect1">
1009 <h2 id="_bugs">BUGS</h2>
1010 <div class="sectionbody">
1011 <div class="paragraph"><p>Each time a superproject update removes a populated submodule
1012 (e.g. when switching between commits before and after the removal) a
1013 stale submodule checkout will remain in the old location. Removing the
1014 old directory is only safe when it uses a gitfile, as otherwise the
1015 history of the submodule will be deleted too. This step will be
1016 obsolete when recursive submodule update has been implemented.</p></div>
1017 </div>
1018 </div>
1019 <div class="sect1">
1020 <h2 id="_see_also">SEE ALSO</h2>
1021 <div class="sectionbody">
1022 <div class="paragraph"><p><a href="git-add.html">git-add(1)</a></p></div>
1023 </div>
1024 </div>
1025 <div class="sect1">
1026 <h2 id="_git">GIT</h2>
1027 <div class="sectionbody">
1028 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1029 </div>
1030 </div>
1031 </div>
1032 <div id="footnotes"><hr /></div>
1033 <div id="footer">
1034 <div id="footer-text">
1035 Last updated
1036  2023-10-23 14:43:46 PDT
1037 </div>
1038 </div>
1039 </body>
1040 </html>