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] [-n] [-r] [--cached] [--] <file>...
  11
  12 DESCRIPTION
  13 -----------
  14 Remove files from the working tree and from the index.  The
  15 files have to be identical to the tip of the branch, and no
  16 updates to its contents must have been placed in the staging
  17 area (aka index).
  18
  19
  20 OPTIONS
  21 -------
  22 <file>...::
  23         Files to remove.  Fileglobs (e.g. `*.c`) can be given to
  24         remove all matching files.  Also a leading directory name
  25         (e.g. `dir` to add `dir/file1` and `dir/file2`) can be
  26         given to remove all files in the directory, recursively,
  27         but this requires `-r` option to be given for safety.
  28
  29 -f::
  30         Override the up-to-date check.
  31
  32 -n::
  33         Don't actually remove the file(s), just show if they exist in
  34         the index.
  35
  36 -r::
  37         Allow recursive removal when a leading directory name is
  38         given.
  39
  40 \--::
  41         This option can be used to separate command-line options from
  42         the list of files, (useful when filenames might be mistaken
  43         for command-line options).
  44
  45 \--cached::
  46         This option can be used to tell the command to remove
  47         the paths only from the index, leaving working tree
  48         files.
  49
  50
  51 DISCUSSION
  52 ----------
  53
  54 The list of <file> given to the command can be exact pathnames,
  55 file glob patterns, or leading directory name.  The command
  56 removes only the paths that is known to git.  Giving the name of
  57 a file that you have not told git about does not remove that file.
  58
  59
  60 EXAMPLES
  61 --------
  62 git-rm Documentation/\\*.txt::
  63
  64         Removes all `\*.txt` files from the index that are under the
  65         `Documentation` directory and any of its subdirectories. The
  66         files are not removed from the working tree.
  67 +
  68 Note that the asterisk `\*` is quoted from the shell in this
  69 example; this lets the command include the files from
  70 subdirectories of `Documentation/` directory.
  71
  72 git-rm -f git-*.sh::
  73
  74         Remove all git-*.sh scripts that are in the index. The files
  75         are removed from the index, and from the working
  76         tree. Because this example lets the shell expand the
  77         asterisk (i.e. you are listing the files explicitly), it
  78         does not remove `subdir/git-foo.sh`.
  79
  80 See Also
  81 --------
  82 gitlink:git-add[1]
  83
  84 Author
  85 ------
  86 Written by Linus Torvalds <torvalds@osdl.org>
  87
  88 Documentation
  89 --------------
  90 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  91
  92 GIT
  93 ---
  94 Part of the gitlink:git[7] suite
  95