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] [-f] [-n] [-q] [-x | -X] [--] <path>...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 This allows cleaning the working tree by removing files that are not
  17 under version control.
  18
  19 Normally, only files unknown to git are removed, but if the '-x'
  20 option is specified, ignored files are also removed. This can, for
  21 example, be useful to remove all build products.
  22
  23 If any optional `<path>...` arguments are given, only those paths
  24 are affected.
  25
  26 OPTIONS
  27 -------
  28 -d::
  29         Remove untracked directories in addition to untracked files.
  30
  31 -f::
  32         If the git configuration specifies clean.requireForce as true,
  33         'git-clean' will refuse to run unless given -f or -n.
  34
  35 -n::
  36 --dry-run::
  37         Don't actually remove anything, just show what would be done.
  38
  39 -q::
  40 --quiet::
  41         Be quiet, only report errors, but not the files that are
  42         successfully removed.
  43
  44 -x::
  45         Don't use the ignore rules.  This allows removing all untracked
  46         files, including build products.  This can be used (possibly in
  47         conjunction with 'git-reset') to create a pristine
  48         working directory to test a clean build.
  49
  50 -X::
  51         Remove only files ignored by git.  This may be useful to rebuild
  52         everything from scratch, but keep manually created files.
  53
  54
  55 Author
  56 ------
  57 Written by Pavel Roskin <proski@gnu.org>
  58
  59
  60 GIT
  61 ---
  62 Part of the linkgit:git[1] suite