Merge branch 'jc/symref'
[git.git] / Documentation / git-clean.txt
1 git-clean(1)
2 ============
3
4 NAME
5 ----
6 git-clean - Remove untracked files from the working tree
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git-clean' [-d] [-n] [-q] [-x | -X]
12
13 DESCRIPTION
14 -----------
15 Removes files unknown to git.  This allows to clean the working tree
16 from files that are not under version control.  If the '-x' option is
17 specified, ignored files are also removed, allowing to remove all
18 build products.
19
20 OPTIONS
21 -------
22 -d::
23         Remove untracked directories in addition to untracked files.
24
25 -n::
26         Don't actually remove anything, just show what would be done.
27
28 -q::
29         Be quiet, only report errors, but not the files that are
30         successfully removed.
31
32 -x::
33         Don't use the ignore rules.  This allows removing all untracked
34         files, including build products.  This can be used (possibly in
35         conjunction with gitlink:git-reset[1]) to create a pristine
36         working directory to test a clean build.
37
38 -X::
39         Remove only files ignored by git.  This may be useful to rebuild
40         everything from scratch, but keep manually created files.
41
42
43 Author
44 ------
45 Written by Pavel Roskin <proski@gnu.org>
46
47
48 GIT
49 ---
50 Part of the gitlink:git[7] suite