]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - Documentation/git-clean.txt
Documentation: be consistent about "git-" versus "git "
[thirdparty/git.git] / Documentation / git-clean.txt
... / ...
CommitLineData
1git-clean(1)
2============
3
4NAME
5----
6git-clean - Remove untracked files from the working tree
7
8SYNOPSIS
9--------
10[verse]
11'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
12
13DESCRIPTION
14-----------
15Removes files unknown to git. This allows to clean the working tree
16from files that are not under version control. If the '-x' option is
17specified, ignored files are also removed, allowing to remove all
18build products.
19When optional `<paths>...` arguments are given, the paths
20affected are further limited to those that match them.
21
22
23OPTIONS
24-------
25-d::
26 Remove untracked directories in addition to untracked files.
27
28-f::
29 If the git configuration specifies clean.requireForce as true,
30 git-clean will refuse to run unless given -f or -n.
31
32-n::
33--dry-run::
34 Don't actually remove anything, just show what would be done.
35
36-q::
37--quiet::
38 Be quiet, only report errors, but not the files that are
39 successfully removed.
40
41-x::
42 Don't use the ignore rules. This allows removing all untracked
43 files, including build products. This can be used (possibly in
44 conjunction with linkgit:git-reset[1]) to create a pristine
45 working directory to test a clean build.
46
47-X::
48 Remove only files ignored by git. This may be useful to rebuild
49 everything from scratch, but keep manually created files.
50
51
52Author
53------
54Written by Pavel Roskin <proski@gnu.org>
55
56
57GIT
58---
59Part of the linkgit:git[1] suite