OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-rm.html.xml
diff --git a/doc/source/en/TortoiseGit/git_doc/git-rm.html.xml b/doc/source/en/TortoiseGit/git_doc/git-rm.html.xml
new file mode 100644 (file)
index 0000000..4818f6d
--- /dev/null
@@ -0,0 +1,199 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
+\r
+<article lang="en" id="git-rm(1)">\r
+<articleinfo>\r
+    <title>git-rm(1)</title>\r
+        <indexterm>\r
+                <primary>git-rm(1)</primary>\r
+        </indexterm>\r
+</articleinfo>\r
+<simplesect id="_name">\r
+<title>NAME</title>\r
+<simpara>git-rm - Remove files from the working tree and from the index</simpara>\r
+</simplesect>\r
+<simplesect id="_synopsis">\r
+<title>SYNOPSIS</title>\r
+<simpara><emphasis>git rm</emphasis> [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] &lt;file&gt;&#8230;</simpara>\r
+</simplesect>\r
+<simplesect id="_description">\r
+<title>DESCRIPTION</title>\r
+<simpara>Remove files from the index, or from the working tree and the index.\r
+<emphasis>git-rm</emphasis> will not remove a file from just your working directory.\r
+(There is no option to remove a file only from the work tree\r
+and yet keep it in the index; use <literal>/bin/rm</literal> if you want to do that.)\r
+The files being removed have to be identical to the tip of the branch,\r
+and no updates to their contents can be staged in the index,\r
+though that default behavior can be overridden with the <literal>-f</literal> option.\r
+When <emphasis>--cached</emphasis> is given, the staged content has to\r
+match either the tip of the branch or the file on disk,\r
+allowing the file to be removed from just the index.</simpara>\r
+</simplesect>\r
+<simplesect id="_options">\r
+<title>OPTIONS</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+&lt;file&gt;&#8230;\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Files to remove.  Fileglobs (e.g. <literal>*.c</literal>) can be given to\r
+        remove all matching files.  If you want git to expand\r
+        file glob characters, you may need to shell-escape them.\r
+        A leading directory name\r
+        (e.g. <literal>dir</literal> to remove <literal>dir/file1</literal> and <literal>dir/file2</literal>) can be\r
+        given to remove all files in the directory, and recursively\r
+        all sub-directories,\r
+        but this requires the <literal>-r</literal> option to be explicitly given.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-f\r
+</term>\r
+<term>\r
+--force\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Override the up-to-date check.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-n\r
+</term>\r
+<term>\r
+--dry-run\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Don&#8217;t actually remove any file(s).  Instead, just show\r
+        if they exist in the index and would otherwise be removed\r
+        by the command.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-r\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Allow recursive removal when a leading directory name is\r
+        given.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+--\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        This option can be used to separate command-line options from\r
+        the list of files, (useful when filenames might be mistaken\r
+        for command-line options).\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+--cached\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Use this option to unstage and remove paths only from the index.\r
+        Working tree files, whether modified or not, will be\r
+        left alone.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+--ignore-unmatch\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Exit with a zero status even if no files matched.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+-q\r
+</term>\r
+<term>\r
+--quiet\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        <emphasis>git-rm</emphasis> normally outputs one line (in the form of an "rm" command)\r
+        for each file removed. This option suppresses that output.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_discussion">\r
+<title>DISCUSSION</title>\r
+<simpara>The &lt;file&gt; list given to the command can be exact pathnames,\r
+file glob patterns, or leading directory names.  The command\r
+removes only the paths that are known to git.  Giving the name of\r
+a file that you have not told git about does not remove that file.</simpara>\r
+<simpara>File globbing matches across directory boundaries.  Thus, given\r
+two directories &#8216;d` and <literal>d2</literal>, there is a difference between\r
+using <literal>git rm 'd*&#8217;</literal> and &#8216;git rm 'd/\*\&#8217;<literal>, as the former will\r
+also remove all of directory `d2</literal>.</simpara>\r
+</simplesect>\r
+<simplesect id="_examples">\r
+<title>EXAMPLES</title>\r
+<variablelist>\r
+<varlistentry>\r
+<term>\r
+git rm Documentation/\\*.txt\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Removes all <literal>\*.txt</literal> files from the index that are under the\r
+        <literal>Documentation</literal> directory and any of its subdirectories.\r
+</simpara>\r
+<simpara>Note that the asterisk <literal>\*</literal> is quoted from the shell in this\r
+example; this lets git, and not the shell, expand the pathnames\r
+of files and subdirectories under the <literal>Documentation/</literal> directory.</simpara>\r
+</listitem>\r
+</varlistentry>\r
+<varlistentry>\r
+<term>\r
+git rm -f git-*.sh\r
+</term>\r
+<listitem>\r
+<simpara>\r
+        Because this example lets the shell expand the asterisk\r
+        (i.e. you are listing the files explicitly), it\r
+        does not remove <literal>subdir/git-foo.sh</literal>.\r
+</simpara>\r
+</listitem>\r
+</varlistentry>\r
+</variablelist>\r
+</simplesect>\r
+<simplesect id="_see_also">\r
+<title>SEE ALSO</title>\r
+<simpara><xref linkend="git-add(1)"/></simpara>\r
+</simplesect>\r
+<simplesect id="_author">\r
+<title>Author</title>\r
+<simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
+</simplesect>\r
+<simplesect id="_documentation">\r
+<title>Documentation</title>\r
+<simpara>Documentation by Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
+</simplesect>\r
+<simplesect id="_git">\r
+<title>GIT</title>\r
+<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
+</simplesect>\r
+</article>\r