Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / git / Documentation / git-clean.txt
blobe3252d59daa33576c0b00bd5f2daa3a5b50c9b7a
1 git-clean(1)
2 ============
4 NAME
5 ----
6 git-clean - Remove untracked files from the working tree
8 SYNOPSIS
9 --------
10 [verse]
11 'git-clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
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 When optional `<paths>...` arguments are given, the paths
20 affected are further limited to those that match them.
23 OPTIONS
24 -------
25 -d::
26         Remove untracked directories in addition to untracked files.
28 -f::
29         If the git configuration specifies clean.requireForce as true,
30         git-clean will refuse to run unless given -f or -n.
32 -n::
33         Don't actually remove anything, just show what would be done.
35 -q::
36         Be quiet, only report errors, but not the files that are
37         successfully removed.
39 -x::
40         Don't use the ignore rules.  This allows removing all untracked
41         files, including build products.  This can be used (possibly in
42         conjunction with gitlink:git-reset[1]) to create a pristine
43         working directory to test a clean build.
45 -X::
46         Remove only files ignored by git.  This may be useful to rebuild
47         everything from scratch, but keep manually created files.
50 Author
51 ------
52 Written by Pavel Roskin <proski@gnu.org>
55 GIT
56 ---
57 Part of the gitlink:git[7] suite