OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-check-attr.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-check-attr(1)">\r
5 <articleinfo>\r
6     <title>git-check-attr(1)</title>\r
7         <indexterm>\r
8                 <primary>git-check-attr(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-check-attr - Display gitattributes information</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git check-attr</emphasis> attr&#8230; [--] pathname&#8230;\r
19 <emphasis>git check-attr</emphasis> --stdin [-z] attr&#8230; &lt; &lt;list-of-paths&gt;</literallayout>\r
20 </blockquote>\r
21 </simplesect>\r
22 <simplesect id="_description">\r
23 <title>DESCRIPTION</title>\r
24 <simpara>For every pathname, this command will list if each attr is <emphasis>unspecified</emphasis>,\r
25 <emphasis>set</emphasis>, or <emphasis>unset</emphasis> as a gitattribute on that pathname.</simpara>\r
26 </simplesect>\r
27 <simplesect id="_options">\r
28 <title>OPTIONS</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term>\r
32 --stdin\r
33 </term>\r
34 <listitem>\r
35 <simpara>\r
36         Read file names from stdin instead of from the command-line.\r
37 </simpara>\r
38 </listitem>\r
39 </varlistentry>\r
40 <varlistentry>\r
41 <term>\r
42 -z\r
43 </term>\r
44 <listitem>\r
45 <simpara>\r
46         Only meaningful with <literal>--stdin</literal>; paths are separated with\r
47         NUL character instead of LF.\r
48 </simpara>\r
49 </listitem>\r
50 </varlistentry>\r
51 <varlistentry>\r
52 <term>\r
53 --\r
54 </term>\r
55 <listitem>\r
56 <simpara>\r
57         Interpret all preceding arguments as attributes, and all following\r
58         arguments as path names. If not supplied, only the first argument will\r
59         be treated as an attribute.\r
60 </simpara>\r
61 </listitem>\r
62 </varlistentry>\r
63 </variablelist>\r
64 </simplesect>\r
65 <simplesect id="_output">\r
66 <title>OUTPUT</title>\r
67 <simpara>The output is of the form:\r
68 &lt;path&gt; COLON SP &lt;attribute&gt; COLON SP &lt;info&gt; LF</simpara>\r
69 <simpara>Where &lt;path&gt; is the path of a file being queried, &lt;attribute&gt; is an attribute\r
70 being queried and &lt;info&gt; can be either:</simpara>\r
71 <variablelist>\r
72 <varlistentry>\r
73 <term>\r
74 <emphasis>unspecified</emphasis>\r
75 </term>\r
76 <listitem>\r
77 <simpara>\r
78 when the attribute is not defined for the path.\r
79 </simpara>\r
80 </listitem>\r
81 </varlistentry>\r
82 <varlistentry>\r
83 <term>\r
84 <emphasis>unset</emphasis>\r
85 </term>\r
86 <listitem>\r
87 <simpara>\r
88 when the attribute is defined to false.\r
89 </simpara>\r
90 </listitem>\r
91 </varlistentry>\r
92 <varlistentry>\r
93 <term>\r
94 <emphasis>set</emphasis>\r
95 </term>\r
96 <listitem>\r
97 <simpara>\r
98 when the attribute is defined to true.\r
99 </simpara>\r
100 </listitem>\r
101 </varlistentry>\r
102 <varlistentry>\r
103 <term>\r
104 &lt;value&gt;\r
105 </term>\r
106 <listitem>\r
107 <simpara>\r
108 when a value has been assigned to the attribute.\r
109 </simpara>\r
110 </listitem>\r
111 </varlistentry>\r
112 </variablelist>\r
113 </simplesect>\r
114 <simplesect id="_examples">\r
115 <title>EXAMPLES</title>\r
116 <simpara>In the examples, the following <emphasis>.gitattributes</emphasis> file is used:</simpara>\r
117 <literallayout>*.java diff=java -crlf myAttr\r
118 NoMyAttr.java !myAttr\r
119 README caveat=unspecified</literallayout>\r
120 <itemizedlist>\r
121 <listitem>\r
122 <simpara>\r
123 Listing a single attribute:\r
124 </simpara>\r
125 </listitem>\r
126 </itemizedlist>\r
127 <literallayout>$ git check-attr diff org/example/MyClass.java\r
128 org/example/MyClass.java: diff: java</literallayout>\r
129 <itemizedlist>\r
130 <listitem>\r
131 <simpara>\r
132 Listing multiple attributes for a file:\r
133 </simpara>\r
134 </listitem>\r
135 </itemizedlist>\r
136 <literallayout>$ git check-attr crlf diff myAttr -- org/example/MyClass.java\r
137 org/example/MyClass.java: crlf: unset\r
138 org/example/MyClass.java: diff: java\r
139 org/example/MyClass.java: myAttr: set</literallayout>\r
140 <itemizedlist>\r
141 <listitem>\r
142 <simpara>\r
143 Listing attribute for multiple files:\r
144 </simpara>\r
145 </listitem>\r
146 </itemizedlist>\r
147 <literallayout>$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java\r
148 org/example/MyClass.java: myAttr: set\r
149 org/example/NoMyAttr.java: myAttr: unspecified</literallayout>\r
150 <itemizedlist>\r
151 <listitem>\r
152 <simpara>\r
153 Not all values are equally unambiguous:\r
154 </simpara>\r
155 </listitem>\r
156 </itemizedlist>\r
157 <literallayout>$ git check-attr caveat README\r
158 README: caveat: unspecified</literallayout>\r
159 </simplesect>\r
160 <simplesect id="_see_also">\r
161 <title>SEE ALSO</title>\r
162 <simpara><xref linkend="gitattributes(5)"/>.</simpara>\r
163 </simplesect>\r
164 <simplesect id="_author">\r
165 <title>Author</title>\r
166 <simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
167 </simplesect>\r
168 <simplesect id="_documentation">\r
169 <title>Documentation</title>\r
170 <simpara>Documentation by James Bowes.</simpara>\r
171 </simplesect>\r
172 <simplesect id="_git">\r
173 <title>GIT</title>\r
174 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
175 </simplesect>\r
176 </article>\r