OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-clean.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-clean(1)">\r
5 <articleinfo>\r
6     <title>git-clean(1)</title>\r
7         <indexterm>\r
8                 <primary>git-clean(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-clean - Remove untracked files from the working tree</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git clean</emphasis> [-d] [-f] [-n] [-q] [-x | -X] [--] &lt;path&gt;&#8230;</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>Removes files unknown to git.  This allows to clean the working tree\r
24 from files that are not under version control.  If the <emphasis>-x</emphasis> option is\r
25 specified, ignored files are also removed, allowing to remove all\r
26 build products.\r
27 If any optional <literal>&lt;path&gt;&#8230;</literal> arguments are given, only those paths\r
28 are affected.</simpara>\r
29 </simplesect>\r
30 <simplesect id="_options">\r
31 <title>OPTIONS</title>\r
32 <variablelist>\r
33 <varlistentry>\r
34 <term>\r
35 -d\r
36 </term>\r
37 <listitem>\r
38 <simpara>\r
39         Remove untracked directories in addition to untracked files.\r
40 </simpara>\r
41 </listitem>\r
42 </varlistentry>\r
43 <varlistentry>\r
44 <term>\r
45 -f\r
46 </term>\r
47 <listitem>\r
48 <simpara>\r
49         If the git configuration specifies clean.requireForce as true,\r
50         <emphasis>git-clean</emphasis> will refuse to run unless given -f or -n.\r
51 </simpara>\r
52 </listitem>\r
53 </varlistentry>\r
54 <varlistentry>\r
55 <term>\r
56 -n\r
57 </term>\r
58 <term>\r
59 --dry-run\r
60 </term>\r
61 <listitem>\r
62 <simpara>\r
63         Don&#8217;t actually remove anything, just show what would be done.\r
64 </simpara>\r
65 </listitem>\r
66 </varlistentry>\r
67 <varlistentry>\r
68 <term>\r
69 -q\r
70 </term>\r
71 <term>\r
72 --quiet\r
73 </term>\r
74 <listitem>\r
75 <simpara>\r
76         Be quiet, only report errors, but not the files that are\r
77         successfully removed.\r
78 </simpara>\r
79 </listitem>\r
80 </varlistentry>\r
81 <varlistentry>\r
82 <term>\r
83 -x\r
84 </term>\r
85 <listitem>\r
86 <simpara>\r
87         Don&#8217;t use the ignore rules.  This allows removing all untracked\r
88         files, including build products.  This can be used (possibly in\r
89         conjunction with <emphasis>git-reset</emphasis>) to create a pristine\r
90         working directory to test a clean build.\r
91 </simpara>\r
92 </listitem>\r
93 </varlistentry>\r
94 <varlistentry>\r
95 <term>\r
96 -X\r
97 </term>\r
98 <listitem>\r
99 <simpara>\r
100         Remove only files ignored by git.  This may be useful to rebuild\r
101         everything from scratch, but keep manually created files.\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 </variablelist>\r
106 </simplesect>\r
107 <simplesect id="_author">\r
108 <title>Author</title>\r
109 <simpara>Written by Pavel Roskin &lt;<ulink url="mailto:proski@gnu.org">proski@gnu.org</ulink>&gt;</simpara>\r
110 </simplesect>\r
111 <simplesect id="_git">\r
112 <title>GIT</title>\r
113 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
114 </simplesect>\r
115 </article>\r