Autogenerated man pages for v1.4.0-rc1-gdd82
[git.git] / man1 / git-clean.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-CLEAN" 1 "" "" ""
21 .SH NAME
22 git-clean \- Remove untracked files from the working tree
23 .SH "SYNOPSIS"
24
25 .nf
26 \fIgit\-clean\fR [\-d] [\-n] [\-q] [\-x | \-X] [\-\-] <paths>...
27 .fi
28
29 .SH "DESCRIPTION"
30
31
32 Removes files unknown to git\&. This allows to clean the working tree from files that are not under version control\&. If the \fI\-x\fR option is specified, ignored files are also removed, allowing to remove all build products\&. When optional <paths>... arguments are given, the paths affected are further limited to those that match them\&.
33
34 .SH "OPTIONS"
35
36 .TP
37 \-d
38 Remove untracked directories in addition to untracked files\&.
39
40 .TP
41 \-n
42 Don't actually remove anything, just show what would be done\&.
43
44 .TP
45 \-q
46 Be quiet, only report errors, but not the files that are successfully removed\&.
47
48 .TP
49 \-x
50 Don't use the ignore rules\&. This allows removing all untracked files, including build products\&. This can be used (possibly in conjunction with \fBgit\-reset\fR(1)) to create a pristine working directory to test a clean build\&.
51
52 .TP
53 \-X
54 Remove only files ignored by git\&. This may be useful to rebuild everything from scratch, but keep manually created files\&.
55
56 .SH "AUTHOR"
57
58
59 Written by Pavel Roskin <proski@gnu\&.org>
60
61 .SH "GIT"
62
63
64 Part of the \fBgit\fR(7) suite
65