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] [--] <file>... 11 12DESCRIPTION 13----------- 14Remove files from the working tree and from the index. The 15files have to be identical to the tip of the branch, and no 16updates to its contents must have been placed in the staging 17area (aka index). 18 19 20OPTIONS 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\--quiet:: 51 git-rm normally outputs one line (in the form of an "rm" command) 52 for each file removed. This option suppresses that output. 53 54 55DISCUSSION 56---------- 57 58The list of <file> given to the command can be exact pathnames, 59file glob patterns, or leading directory name. The command 60removes only the paths that is known to git. Giving the name of 61a file that you have not told git about does not remove that file. 62 63 64EXAMPLES 65-------- 66git-rm Documentation/\\*.txt:: 67 Removes all `\*.txt` files from the index that are under the 68 `Documentation` directory and any of its subdirectories. 69+ 70Note that the asterisk `\*` is quoted from the shell in this 71example; this lets the command include the files from 72subdirectories of `Documentation/` directory. 73 74git-rm -f git-*.sh:: 75 Remove all git-*.sh scripts that are in the index. 76 Because this example lets the shell expand the asterisk 77 (i.e. you are listing the files explicitly), it 78 does not remove `subdir/git-foo.sh`. 79 80See Also 81-------- 82gitlink:git-add[1] 83 84Author 85------ 86Written by Linus Torvalds <torvalds@osdl.org> 87 88Documentation 89-------------- 90Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. 91 92GIT 93--- 94Part of the gitlink:git[7] suite 95