Autogenerated HTML docs for v1.7.7-rc2-4-g5ec82
[git/jnareb-git.git] / git-rm.html
blobb968a9eaf0b2d16c9157d6541216717571ddd603
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>git-rm(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-rm(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-rm -
578 Remove files from the working tree and from the index
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git rm</em> [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] &lt;file&gt;&#8230;</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>Remove files from the index, or from the working tree and the index.
593 <tt>git rm</tt> will not remove a file from just your working directory.
594 (There is no option to remove a file only from the working tree
595 and yet keep it in the index; use <tt>/bin/rm</tt> if you want to do that.)
596 The files being removed have to be identical to the tip of the branch,
597 and no updates to their contents can be staged in the index,
598 though that default behavior can be overridden with the <tt>-f</tt> option.
599 When <tt>--cached</tt> is given, the staged content has to
600 match either the tip of the branch or the file on disk,
601 allowing the file to be removed from just the index.</p></div>
602 </div>
603 <h2 id="_options">OPTIONS</h2>
604 <div class="sectionbody">
605 <div class="dlist"><dl>
606 <dt class="hdlist1">
607 &lt;file&gt;&#8230;
608 </dt>
609 <dd>
611 Files to remove. Fileglobs (e.g. <tt>*.c</tt>) can be given to
612 remove all matching files. If you want git to expand
613 file glob characters, you may need to shell-escape them.
614 A leading directory name
615 (e.g. <tt>dir</tt> to remove <tt>dir/file1</tt> and <tt>dir/file2</tt>) can be
616 given to remove all files in the directory, and recursively
617 all sub-directories,
618 but this requires the <tt>-r</tt> option to be explicitly given.
619 </p>
620 </dd>
621 <dt class="hdlist1">
623 </dt>
624 <dt class="hdlist1">
625 --force
626 </dt>
627 <dd>
629 Override the up-to-date check.
630 </p>
631 </dd>
632 <dt class="hdlist1">
634 </dt>
635 <dt class="hdlist1">
636 --dry-run
637 </dt>
638 <dd>
640 Don&#8217;t actually remove any file(s). Instead, just show
641 if they exist in the index and would otherwise be removed
642 by the command.
643 </p>
644 </dd>
645 <dt class="hdlist1">
647 </dt>
648 <dd>
650 Allow recursive removal when a leading directory name is
651 given.
652 </p>
653 </dd>
654 <dt class="hdlist1">
656 </dt>
657 <dd>
659 This option can be used to separate command-line options from
660 the list of files, (useful when filenames might be mistaken
661 for command-line options).
662 </p>
663 </dd>
664 <dt class="hdlist1">
665 --cached
666 </dt>
667 <dd>
669 Use this option to unstage and remove paths only from the index.
670 Working tree files, whether modified or not, will be
671 left alone.
672 </p>
673 </dd>
674 <dt class="hdlist1">
675 --ignore-unmatch
676 </dt>
677 <dd>
679 Exit with a zero status even if no files matched.
680 </p>
681 </dd>
682 <dt class="hdlist1">
684 </dt>
685 <dt class="hdlist1">
686 --quiet
687 </dt>
688 <dd>
690 <tt>git rm</tt> normally outputs one line (in the form of an <tt>rm</tt> command)
691 for each file removed. This option suppresses that output.
692 </p>
693 </dd>
694 </dl></div>
695 </div>
696 <h2 id="_discussion">DISCUSSION</h2>
697 <div class="sectionbody">
698 <div class="paragraph"><p>The &lt;file&gt; list given to the command can be exact pathnames,
699 file glob patterns, or leading directory names. The command
700 removes only the paths that are known to git. Giving the name of
701 a file that you have not told git about does not remove that file.</p></div>
702 <div class="paragraph"><p>File globbing matches across directory boundaries. Thus, given
703 two directories <tt>d</tt> and <tt>d2</tt>, there is a difference between
704 using <tt>git rm &#39;d&#42;&#39;</tt> and
705 <tt>git rm &#39;d/&#42;&#39;</tt>, as the former will
706 also remove all of directory <tt>d2</tt>.</p></div>
707 </div>
708 <h2 id="_removing_files_that_have_disappeared_from_the_filesystem">REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM</h2>
709 <div class="sectionbody">
710 <div class="paragraph"><p>There is no option for <tt>git rm</tt> to remove from the index only
711 the paths that have disappeared from the filesystem. However,
712 depending on the use case, there are several ways that can be
713 done.</p></div>
714 <h3 id="_using_8220_git_commit_a_8221">Using &#8220;git commit -a&#8221;</h3><div style="clear:left"></div>
715 <div class="paragraph"><p>If you intend that your next commit should record all modifications
716 of tracked files in the working tree and record all removals of
717 files that have been removed from the working tree with <tt>rm</tt>
718 (as opposed to <tt>git rm</tt>), use <tt>git commit -a</tt>, as it will
719 automatically notice and record all removals. You can also have a
720 similar effect without committing by using <tt>git add -u</tt>.</p></div>
721 <h3 id="_using_8220_git_add_a_8221">Using &#8220;git add -A&#8221;</h3><div style="clear:left"></div>
722 <div class="paragraph"><p>When accepting a new code drop for a vendor branch, you probably
723 want to record both the removal of paths and additions of new paths
724 as well as modifications of existing paths.</p></div>
725 <div class="paragraph"><p>Typically you would first remove all tracked files from the working
726 tree using this command:</p></div>
727 <div class="listingblock">
728 <div class="content">
729 <pre><tt>git ls-files -z | xargs -0 rm -f</tt></pre>
730 </div></div>
731 <div class="paragraph"><p>and then untar the new code in the working tree. Alternately
732 you could <em>rsync</em> the changes into the working tree.</p></div>
733 <div class="paragraph"><p>After that, the easiest way to record all removals, additions, and
734 modifications in the working tree is:</p></div>
735 <div class="listingblock">
736 <div class="content">
737 <pre><tt>git add -A</tt></pre>
738 </div></div>
739 <div class="paragraph"><p>See <a href="git-add.html">git-add(1)</a>.</p></div>
740 <h3 id="_other_ways">Other ways</h3><div style="clear:left"></div>
741 <div class="paragraph"><p>If all you really want to do is to remove from the index the files
742 that are no longer present in the working tree (perhaps because
743 your working tree is dirty so that you cannot use <tt>git commit -a</tt>),
744 use the following command:</p></div>
745 <div class="listingblock">
746 <div class="content">
747 <pre><tt>git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached</tt></pre>
748 </div></div>
749 </div>
750 <h2 id="_examples">EXAMPLES</h2>
751 <div class="sectionbody">
752 <div class="dlist"><dl>
753 <dt class="hdlist1">
754 <tt>git rm Documentation/\*.txt</tt>
755 </dt>
756 <dd>
758 Removes all <tt>*.txt</tt> files from the index that are under the
759 <tt>Documentation</tt> directory and any of its subdirectories.
760 </p>
761 <div class="paragraph"><p>Note that the asterisk <tt>*</tt> is quoted from the shell in this
762 example; this lets git, and not the shell, expand the pathnames
763 of files and subdirectories under the <tt>Documentation/</tt> directory.</p></div>
764 </dd>
765 <dt class="hdlist1">
766 <tt>git rm -f git-*.sh</tt>
767 </dt>
768 <dd>
770 Because this example lets the shell expand the asterisk
771 (i.e. you are listing the files explicitly), it
772 does not remove <tt>subdir/git-foo.sh</tt>.
773 </p>
774 </dd>
775 </dl></div>
776 </div>
777 <h2 id="_see_also">SEE ALSO</h2>
778 <div class="sectionbody">
779 <div class="paragraph"><p><a href="git-add.html">git-add(1)</a></p></div>
780 </div>
781 <h2 id="_git">GIT</h2>
782 <div class="sectionbody">
783 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
784 </div>
785 </div>
786 <div id="footnotes"><hr /></div>
787 <div id="footer">
788 <div id="footer-text">
789 Last updated 2011-09-21 23:01:14 PDT
790 </div>
791 </div>
792 </body>
793 </html>