man1/git-rm.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-RM" 1 "" "" ""
  21 .SH NAME
  22 git-rm \- Remove files from the working tree and from the index
  23 .SH "SYNOPSIS"
  24
  25
  26 \fIgit\-rm\fR [\-f] [\-n] [\-v] [\-\-] <file>...
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 A convenience wrapper for git\-update\-index \-\-remove\&. For those coming from cvs, git\-rm provides an operation similar to "cvs rm" or "cvs remove"\&.
  32
  33 .SH "OPTIONS"
  34
  35 .TP
  36 <file>...
  37 Files to remove from the index and optionally, from the working tree as well\&.
  38
  39 .TP
  40 \-f
  41 Remove files from the working tree as well as from the index\&.
  42
  43 .TP
  44 \-n
  45 Don't actually remove the file(s), just show if they exist in the index\&.
  46
  47 .TP
  48 \-v
  49 Be verbose\&.
  50
  51 .TP
  52 \-\-
  53 This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&.
  54
  55 .SH "DISCUSSION"
  56
  57
  58 The list of <file> given to the command is fed to git\-ls\-files command to list files that are registered in the index and are not ignored/excluded by $GIT_DIR/info/exclude file or \&.gitignore file in each directory\&. This means two things:
  59
  60 .TP 3
  61 1.
  62 You can put the name of a directory on the command line, and the command will remove all files in it and its subdirectories (the directories themselves are never removed from the working tree);
  63 .TP
  64 2.
  65 Giving the name of a file that is not in the index does not remove that file\&.
  66 .LP
  67
  68 .SH "EXAMPLES"
  69
  70 .TP
  71 git\-rm Documentation/\\*\&.txt
  72 Removes all *\&.txt files from the index that are under the Documentation directory and any of its subdirectories\&. The files are not removed from the working tree\&.
  73
  74 Note that the asterisk * is quoted from the shell in this example; this lets the command include the files from subdirectories of Documentation/ directory\&.
  75
  76 .TP
  77 git\-rm \-f git\-*\&.sh
  78 Remove all git\-*\&.sh scripts that are in the index\&. The files are removed from the index, and (because of the \-f option), from the working tree as well\&. Because this example lets the shell expand the asterisk (i\&.e\&. you are listing the files explicitly), it does not remove subdir/git\-foo\&.sh\&.
  79
  80 .SH "SEE ALSO"
  81
  82
  83 \fBgit\-add\fR(1)
  84
  85 .SH "AUTHOR"
  86
  87
  88 Written by Linus Torvalds <torvalds@osdl\&.org>
  89
  90 .SH "DOCUMENTATION"
  91
  92
  93 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
  94
  95 .SH "GIT"
  96
  97
  98 Part of the \fBgit\fR(7) suite
  99