Google Git
Sign in
chromium / external / gitster / git-htmldocs / 619596afe5769620cfbaca941f701a3fa106e6e5 / . / git-clean.html
blob: c3952e32541b6c5e0f8d9bb88c4cd9d44e68a325 [file] [log] [blame]
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]306</style>
307<title>git-clean(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-clean(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-clean -
317 Remove untracked files from the working tree
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
323<div class="verseblock">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame^]324<div class="content"><em>git clean</em> [-d] [-f] [-n] [-q] [-e &lt;pattern&gt;] [-x | -X] [--] &lt;path&gt;&#8230;</div></div>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]325</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]326<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]327<div class="sectionbody">
Junio C Hamanobde411d2009-05-07 05:07:31[diff] [blame]328<div class="para"><p>Cleans the working tree by recursively removing files that are not
329under version control, starting from the current directory.</p></div>
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]330<div class="para"><p>Normally, only files unknown to git are removed, but if the <em>-x</em>
331option is specified, ignored files are also removed. This can, for
332example, be useful to remove all build products.</p></div>
333<div class="para"><p>If any optional <tt>&lt;path&gt;&#8230;</tt> arguments are given, only those paths
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]334are affected.</p></div>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]335</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]336<h2 id="_options">OPTIONS</h2>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]337<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]338<div class="vlist"><dl>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]339<dt>
340-d
341</dt>
342<dd>
343<p>
344 Remove untracked directories in addition to untracked files.
Junio C Hamanoac34f562009-08-16 19:04:05[diff] [blame]345 If an untracked directory is managed by a different git
346 repository, it is not removed by default. Use -f option twice
347 if you really want to remove such a directory.
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]348</p>
349</dd>
350<dt>
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]351-f
352</dt>
Junio C Hamano68cfa3a2009-08-30 00:22:55[diff] [blame]353<dt>
354--force
355</dt>
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]356<dd>
357<p>
Junio C Hamanod3304322010-02-05 03:28:27[diff] [blame]358 If the git configuration variable clean.requireForce is not set
359 to false, <em>git clean</em> will refuse to run unless given -f or -n.
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]360</p>
361</dd>
362<dt>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]363-n
364</dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]365<dt>
366--dry-run
367</dt>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]368<dd>
369<p>
370 Don't actually remove anything, just show what would be done.
371</p>
372</dd>
373<dt>
374-q
375</dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]376<dt>
377--quiet
378</dt>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]379<dd>
380<p>
381 Be quiet, only report errors, but not the files that are
382 successfully removed.
383</p>
384</dd>
385<dt>
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame^]386-e &lt;pattern&gt;
387</dt>
388<dt>
389--exclude=&lt;pattern&gt;
390</dt>
391<dd>
392<p>
393 Specify special exceptions to not be cleaned. Each &lt;pattern&gt; is
394 the same form as in $GIT_DIR/info/excludes and this option can be
395 given multiple times.
396</p>
397</dd>
398<dt>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]399-x
400</dt>
401<dd>
402<p>
403 Don't use the ignore rules. This allows removing all untracked
404 files, including build products. This can be used (possibly in
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]405 conjunction with <em>git reset</em>) to create a pristine
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]406 working directory to test a clean build.
407</p>
408</dd>
409<dt>
410-X
411</dt>
412<dd>
413<p>
414 Remove only files ignored by git. This may be useful to rebuild
415 everything from scratch, but keep manually created files.
416</p>
417</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]418</dl></div>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]419</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]420<h2 id="_author">Author</h2>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]421<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]422<div class="para"><p>Written by Pavel Roskin &lt;proski@gnu.org&gt;</p></div>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]423</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]424<h2 id="_git">GIT</h2>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]425<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]426<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]427</div>
428<div id="footer">
429<div id="footer-text">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame^]430Last updated 2010-08-18 22:14:47 UTC
Junio C Hamano60d00632006-04-05 10:34:43[diff] [blame]431</div>
432</div>
433</body>
434</html>