Autogenerated HTML docs for v1.7.3-rc0-38-g9ab5a
[git/jnareb-git.git] / git-check-attr.html
blob8c039fdcd37f4f763be2f39630a528ae4b0199f6
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-check-attr(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-check-attr(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-check-attr -
317 Display gitattributes information
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="verseblock">
324 <div class="content"><em>git check-attr</em> attr&#8230; [--] pathname&#8230;
325 <em>git check-attr</em> --stdin [-z] attr&#8230; &lt; &lt;list-of-paths&gt;</div></div>
326 </div>
327 <h2 id="_description">DESCRIPTION</h2>
328 <div class="sectionbody">
329 <div class="para"><p>For every pathname, this command will list if each attribute is <em>unspecified</em>,
330 <em>set</em>, or <em>unset</em> as a gitattribute on that pathname.</p></div>
331 </div>
332 <h2 id="_options">OPTIONS</h2>
333 <div class="sectionbody">
334 <div class="vlist"><dl>
335 <dt>
336 --stdin
337 </dt>
338 <dd>
340 Read file names from stdin instead of from the command-line.
341 </p>
342 </dd>
343 <dt>
345 </dt>
346 <dd>
348 Only meaningful with <tt>--stdin</tt>; paths are separated with a
349 NUL character instead of a linefeed character.
350 </p>
351 </dd>
352 <dt>
354 </dt>
355 <dd>
357 Interpret all preceding arguments as attributes and all following
358 arguments as path names. If not supplied, only the first argument will
359 be treated as an attribute.
360 </p>
361 </dd>
362 </dl></div>
363 </div>
364 <h2 id="_output">OUTPUT</h2>
365 <div class="sectionbody">
366 <div class="para"><p>The output is of the form:
367 &lt;path&gt; COLON SP &lt;attribute&gt; COLON SP &lt;info&gt; LF</p></div>
368 <div class="para"><p>&lt;path&gt; is the path of a file being queried, &lt;attribute&gt; is an attribute
369 being queried and &lt;info&gt; can be either:</p></div>
370 <div class="hlist"><table>
371 <tr>
372 <td class="hlist1">
373 <em>unspecified</em>
374 </td>
375 <td class="hlist2">
376 when the attribute is not defined for the path.
377 </td>
378 </tr>
379 <tr>
380 <td class="hlist1">
381 <em>unset</em>
382 </td>
383 <td class="hlist2">
384 when the attribute is defined as false.
385 </td>
386 </tr>
387 <tr>
388 <td class="hlist1">
389 <em>set</em>
390 </td>
391 <td class="hlist2">
392 when the attribute is defined as true.
393 </td>
394 </tr>
395 <tr>
396 <td class="hlist1">
397 &lt;value&gt;
398 </td>
399 <td class="hlist2">
400 when a value has been assigned to the attribute.
401 </td>
402 </tr>
403 </table></div>
404 </div>
405 <h2 id="_examples">EXAMPLES</h2>
406 <div class="sectionbody">
407 <div class="para"><p>In the examples, the following <em>.gitattributes</em> file is used:</p></div>
408 <div class="listingblock">
409 <div class="content">
410 <pre><tt>*.java diff=java -crlf myAttr
411 NoMyAttr.java !myAttr
412 README caveat=unspecified</tt></pre>
413 </div></div>
414 <div class="ilist"><ul>
415 <li>
417 Listing a single attribute:
418 </p>
419 </li>
420 </ul></div>
421 <div class="listingblock">
422 <div class="content">
423 <pre><tt>$ git check-attr diff org/example/MyClass.java
424 org/example/MyClass.java: diff: java</tt></pre>
425 </div></div>
426 <div class="ilist"><ul>
427 <li>
429 Listing multiple attributes for a file:
430 </p>
431 </li>
432 </ul></div>
433 <div class="listingblock">
434 <div class="content">
435 <pre><tt>$ git check-attr crlf diff myAttr -- org/example/MyClass.java
436 org/example/MyClass.java: crlf: unset
437 org/example/MyClass.java: diff: java
438 org/example/MyClass.java: myAttr: set</tt></pre>
439 </div></div>
440 <div class="ilist"><ul>
441 <li>
443 Listing an attribute for multiple files:
444 </p>
445 </li>
446 </ul></div>
447 <div class="listingblock">
448 <div class="content">
449 <pre><tt>$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
450 org/example/MyClass.java: myAttr: set
451 org/example/NoMyAttr.java: myAttr: unspecified</tt></pre>
452 </div></div>
453 <div class="ilist"><ul>
454 <li>
456 Not all values are equally unambiguous:
457 </p>
458 </li>
459 </ul></div>
460 <div class="listingblock">
461 <div class="content">
462 <pre><tt>$ git check-attr caveat README
463 README: caveat: unspecified</tt></pre>
464 </div></div>
465 </div>
466 <h2 id="_see_also">SEE ALSO</h2>
467 <div class="sectionbody">
468 <div class="para"><p><a href="gitattributes.html">gitattributes(5)</a>.</p></div>
469 </div>
470 <h2 id="_author">Author</h2>
471 <div class="sectionbody">
472 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
473 </div>
474 <h2 id="_documentation">Documentation</h2>
475 <div class="sectionbody">
476 <div class="para"><p>Documentation by James Bowes.</p></div>
477 </div>
478 <h2 id="_git">GIT</h2>
479 <div class="sectionbody">
480 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
481 </div>
482 <div id="footer">
483 <div id="footer-text">
484 Last updated 2010-09-03 21:30:04 UTC
485 </div>
486 </div>
487 </body>
488 </html>