Documentation/git-rm.txt

   1 git-rm(1)
   2 =========
   3
   4 NAME
   5 ----
   6 git-rm - Remove files from the working tree and from the index
   7
   8 SYNOPSIS
   9 --------
  10 'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>...
  11
  12 DESCRIPTION
  13 -----------
  14 Remove files from the index, or from the working tree and the index.
  15 'git-rm' will not remove a file from just your working directory.
  16 (There is no option to remove a file only from the work tree
  17 and yet keep it in the index; use `/bin/rm` if you want to do that.)
  18 The files being removed have to be identical to the tip of the branch,
  19 and no updates to their contents can be staged in the index,
  20 though that default behavior can be overridden with the `-f` option.
  21 When '--cached' is given, the staged content has to
  22 match either the tip of the branch or the file on disk,
  23 allowing the file to be removed from just the index.
  24
  25
  26 OPTIONS
  27 -------
  28 <file>...::
  29         Files to remove.  Fileglobs (e.g. `*.c`) can be given to
  30         remove all matching files.  If you want git to expand
  31         file glob characters, you may need to shell-escape them.
  32         A leading directory name
  33         (e.g. `dir` to remove `dir/file1` and `dir/file2`) can be
  34         given to remove all files in the directory, and recursively
  35         all sub-directories,
  36         but this requires the `-r` option to be explicitly given.
  37
  38 -f::
  39 --force::
  40         Override the up-to-date check.
  41
  42 -n::
  43 --dry-run::
  44         Don't actually remove any file(s).  Instead, just show
  45         if they exist in the index and would otherwise be removed
  46         by the command.
  47
  48 -r::
  49         Allow recursive removal when a leading directory name is
  50         given.
  51
  52 \--::
  53         This option can be used to separate command-line options from
  54         the list of files, (useful when filenames might be mistaken
  55         for command-line options).
  56
  57 --cached::
  58         Use this option to unstage and remove paths only from the index.
  59         Working tree files, whether modified or not, will be
  60         left alone.
  61
  62 --ignore-unmatch::
  63         Exit with a zero status even if no files matched.
  64
  65 -q::
  66 --quiet::
  67         'git-rm' normally outputs one line (in the form of an "rm" command)
  68         for each file removed. This option suppresses that output.
  69
  70
  71 DISCUSSION
  72 ----------
  73
  74 The <file> list given to the command can be exact pathnames,
  75 file glob patterns, or leading directory names.  The command
  76 removes only the paths that are known to git.  Giving the name of
  77 a file that you have not told git about does not remove that file.
  78
  79 File globbing matches across directory boundaries.  Thus, given
  80 two directories `d` and `d2`, there is a difference between
  81 using `git rm \'d\*\'` and `git rm \'d/\*\'`, as the former will
  82 also remove all of directory `d2`.
  83
  84 EXAMPLES
  85 --------
  86 git rm Documentation/\\*.txt::
  87         Removes all `\*.txt` files from the index that are under the
  88         `Documentation` directory and any of its subdirectories.
  89 +
  90 Note that the asterisk `\*` is quoted from the shell in this
  91 example; this lets git, and not the shell, expand the pathnames
  92 of files and subdirectories under the `Documentation/` directory.
  93
  94 git rm -f git-*.sh::
  95         Because this example lets the shell expand the asterisk
  96         (i.e. you are listing the files explicitly), it
  97         does not remove `subdir/git-foo.sh`.
  98
  99 SEE ALSO
 100 --------
 101 linkgit:git-add[1]
 102
 103 Author
 104 ------
 105 Written by Linus Torvalds <torvalds@osdl.org>
 106
 107 Documentation
 108 --------------
 109 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 110
 111 GIT
 112 ---
 113 Part of the linkgit:git[1] suite