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