Autogenerated HTML docs for v1.7.5-185-g0b9dee
[git/jnareb-git.git] / git-rm.html
blob1c2da0e539b89f5d9f316634d9b74252b8bcb5e4
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-rm(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-rm -
411 Remove files from the working tree and from the index
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git rm</em> [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] &lt;file&gt;&#8230;</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Remove files from the index, or from the working tree and the index.
422 <tt>git rm</tt> will not remove a file from just your working directory.
423 (There is no option to remove a file only from the working tree
424 and yet keep it in the index; use <tt>/bin/rm</tt> if you want to do that.)
425 The files being removed have to be identical to the tip of the branch,
426 and no updates to their contents can be staged in the index,
427 though that default behavior can be overridden with the <tt>-f</tt> option.
428 When <tt>--cached</tt> is given, the staged content has to
429 match either the tip of the branch or the file on disk,
430 allowing the file to be removed from just the index.</p></div>
431 </div>
432 <h2 id="_options">OPTIONS</h2>
433 <div class="sectionbody">
434 <div class="dlist"><dl>
435 <dt class="hdlist1">
436 &lt;file&gt;&#8230;
437 </dt>
438 <dd>
440 Files to remove. Fileglobs (e.g. <tt>*.c</tt>) can be given to
441 remove all matching files. If you want git to expand
442 file glob characters, you may need to shell-escape them.
443 A leading directory name
444 (e.g. <tt>dir</tt> to remove <tt>dir/file1</tt> and <tt>dir/file2</tt>) can be
445 given to remove all files in the directory, and recursively
446 all sub-directories,
447 but this requires the <tt>-r</tt> option to be explicitly given.
448 </p>
449 </dd>
450 <dt class="hdlist1">
452 </dt>
453 <dt class="hdlist1">
454 --force
455 </dt>
456 <dd>
458 Override the up-to-date check.
459 </p>
460 </dd>
461 <dt class="hdlist1">
463 </dt>
464 <dt class="hdlist1">
465 --dry-run
466 </dt>
467 <dd>
469 Don&#8217;t actually remove any file(s). Instead, just show
470 if they exist in the index and would otherwise be removed
471 by the command.
472 </p>
473 </dd>
474 <dt class="hdlist1">
476 </dt>
477 <dd>
479 Allow recursive removal when a leading directory name is
480 given.
481 </p>
482 </dd>
483 <dt class="hdlist1">
485 </dt>
486 <dd>
488 This option can be used to separate command-line options from
489 the list of files, (useful when filenames might be mistaken
490 for command-line options).
491 </p>
492 </dd>
493 <dt class="hdlist1">
494 --cached
495 </dt>
496 <dd>
498 Use this option to unstage and remove paths only from the index.
499 Working tree files, whether modified or not, will be
500 left alone.
501 </p>
502 </dd>
503 <dt class="hdlist1">
504 --ignore-unmatch
505 </dt>
506 <dd>
508 Exit with a zero status even if no files matched.
509 </p>
510 </dd>
511 <dt class="hdlist1">
513 </dt>
514 <dt class="hdlist1">
515 --quiet
516 </dt>
517 <dd>
519 <tt>git rm</tt> normally outputs one line (in the form of an <tt>rm</tt> command)
520 for each file removed. This option suppresses that output.
521 </p>
522 </dd>
523 </dl></div>
524 </div>
525 <h2 id="_discussion">DISCUSSION</h2>
526 <div class="sectionbody">
527 <div class="paragraph"><p>The &lt;file&gt; list given to the command can be exact pathnames,
528 file glob patterns, or leading directory names. The command
529 removes only the paths that are known to git. Giving the name of
530 a file that you have not told git about does not remove that file.</p></div>
531 <div class="paragraph"><p>File globbing matches across directory boundaries. Thus, given
532 two directories <tt>d</tt> and <tt>d2</tt>, there is a difference between
533 using <tt>git rm &#39;d&#42;&#39;</tt> and
534 <tt>git rm &#39;d/&#42;&#39;</tt>, as the former will
535 also remove all of directory <tt>d2</tt>.</p></div>
536 </div>
537 <h2 id="_removing_files_that_have_disappeared_from_the_filesystem">REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM</h2>
538 <div class="sectionbody">
539 <div class="paragraph"><p>There is no option for <tt>git rm</tt> to remove from the index only
540 the paths that have disappeared from the filesystem. However,
541 depending on the use case, there are several ways that can be
542 done.</p></div>
543 <h3 id="_using_8220_git_commit_a_8221">Using &#8220;git commit -a&#8221;</h3><div style="clear:left"></div>
544 <div class="paragraph"><p>If you intend that your next commit should record all modifications
545 of tracked files in the working tree and record all removals of
546 files that have been removed from the working tree with <tt>rm</tt>
547 (as opposed to <tt>git rm</tt>), use <tt>git commit -a</tt>, as it will
548 automatically notice and record all removals. You can also have a
549 similar effect without committing by using <tt>git add -u</tt>.</p></div>
550 <h3 id="_using_8220_git_add_a_8221">Using &#8220;git add -A&#8221;</h3><div style="clear:left"></div>
551 <div class="paragraph"><p>When accepting a new code drop for a vendor branch, you probably
552 want to record both the removal of paths and additions of new paths
553 as well as modifications of existing paths.</p></div>
554 <div class="paragraph"><p>Typically you would first remove all tracked files from the working
555 tree using this command:</p></div>
556 <div class="listingblock">
557 <div class="content">
558 <pre><tt>git ls-files -z | xargs -0 rm -f</tt></pre>
559 </div></div>
560 <div class="paragraph"><p>and then untar the new code in the working tree. Alternately
561 you could <em>rsync</em> the changes into the working tree.</p></div>
562 <div class="paragraph"><p>After that, the easiest way to record all removals, additions, and
563 modifications in the working tree is:</p></div>
564 <div class="listingblock">
565 <div class="content">
566 <pre><tt>git add -A</tt></pre>
567 </div></div>
568 <div class="paragraph"><p>See <a href="git-add.html">git-add(1)</a>.</p></div>
569 <h3 id="_other_ways">Other ways</h3><div style="clear:left"></div>
570 <div class="paragraph"><p>If all you really want to do is to remove from the index the files
571 that are no longer present in the working tree (perhaps because
572 your working tree is dirty so that you cannot use <tt>git commit -a</tt>),
573 use the following command:</p></div>
574 <div class="listingblock">
575 <div class="content">
576 <pre><tt>git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached</tt></pre>
577 </div></div>
578 </div>
579 <h2 id="_examples">EXAMPLES</h2>
580 <div class="sectionbody">
581 <div class="dlist"><dl>
582 <dt class="hdlist1">
583 git rm Documentation/\*.txt
584 </dt>
585 <dd>
587 Removes all <tt>*.txt</tt> files from the index that are under the
588 <tt>Documentation</tt> directory and any of its subdirectories.
589 </p>
590 <div class="paragraph"><p>Note that the asterisk <tt>*</tt> is quoted from the shell in this
591 example; this lets git, and not the shell, expand the pathnames
592 of files and subdirectories under the <tt>Documentation/</tt> directory.</p></div>
593 </dd>
594 <dt class="hdlist1">
595 git rm -f git-*.sh
596 </dt>
597 <dd>
599 Because this example lets the shell expand the asterisk
600 (i.e. you are listing the files explicitly), it
601 does not remove <tt>subdir/git-foo.sh</tt>.
602 </p>
603 </dd>
604 </dl></div>
605 </div>
606 <h2 id="_see_also">SEE ALSO</h2>
607 <div class="sectionbody">
608 <div class="paragraph"><p><a href="git-add.html">git-add(1)</a></p></div>
609 </div>
610 <h2 id="_git">GIT</h2>
611 <div class="sectionbody">
612 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
613 </div>
614 <div id="footer">
615 <div id="footer-text">
616 Last updated 2011-03-15 23:30:14 UTC
617 </div>
618 </div>
619 </body>
620 </html>