Autogenerated HTML docs for v1.7.4.2-414-g07514
[git/jnareb-git.git] / git-check-attr.html
blob6e5fb00bac91bfbf7ffdd018cfcf46a8e2f3dd53
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.4.5" />
7 <title>git-check-attr(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-check-attr(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-check-attr -
411 Display gitattributes information
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git check-attr</em> attr&#8230; [--] pathname&#8230;
419 <em>git check-attr</em> --stdin [-z] attr&#8230; &lt; &lt;list-of-paths&gt;</div>
420 <div class="verseblock-attribution">
421 </div></div>
422 </div>
423 <h2 id="_description">DESCRIPTION</h2>
424 <div class="sectionbody">
425 <div class="paragraph"><p>For every pathname, this command will list if each attribute is <em>unspecified</em>,
426 <em>set</em>, or <em>unset</em> as a gitattribute on that pathname.</p></div>
427 </div>
428 <h2 id="_options">OPTIONS</h2>
429 <div class="sectionbody">
430 <div class="dlist"><dl>
431 <dt class="hdlist1">
432 --stdin
433 </dt>
434 <dd>
436 Read file names from stdin instead of from the command-line.
437 </p>
438 </dd>
439 <dt class="hdlist1">
441 </dt>
442 <dd>
444 Only meaningful with <tt>--stdin</tt>; paths are separated with a
445 NUL character instead of a linefeed character.
446 </p>
447 </dd>
448 <dt class="hdlist1">
450 </dt>
451 <dd>
453 Interpret all preceding arguments as attributes and all following
454 arguments as path names. If not supplied, only the first argument will
455 be treated as an attribute.
456 </p>
457 </dd>
458 </dl></div>
459 </div>
460 <h2 id="_output">OUTPUT</h2>
461 <div class="sectionbody">
462 <div class="paragraph"><p>The output is of the form:
463 &lt;path&gt; COLON SP &lt;attribute&gt; COLON SP &lt;info&gt; LF</p></div>
464 <div class="paragraph"><p>&lt;path&gt; is the path of a file being queried, &lt;attribute&gt; is an attribute
465 being queried and &lt;info&gt; can be either:</p></div>
466 <div class="dlist"><dl>
467 <dt class="hdlist1">
468 <em>unspecified</em>
469 </dt>
470 <dd>
472 when the attribute is not defined for the path.
473 </p>
474 </dd>
475 <dt class="hdlist1">
476 <em>unset</em>
477 </dt>
478 <dd>
480 when the attribute is defined as false.
481 </p>
482 </dd>
483 <dt class="hdlist1">
484 <em>set</em>
485 </dt>
486 <dd>
488 when the attribute is defined as true.
489 </p>
490 </dd>
491 <dt class="hdlist1">
492 &lt;value&gt;
493 </dt>
494 <dd>
496 when a value has been assigned to the attribute.
497 </p>
498 </dd>
499 </dl></div>
500 </div>
501 <h2 id="_examples">EXAMPLES</h2>
502 <div class="sectionbody">
503 <div class="paragraph"><p>In the examples, the following <em>.gitattributes</em> file is used:</p></div>
504 <div class="listingblock">
505 <div class="content">
506 <pre><tt>*.java diff=java -crlf myAttr
507 NoMyAttr.java !myAttr
508 README caveat=unspecified</tt></pre>
509 </div></div>
510 <div class="ulist"><ul>
511 <li>
513 Listing a single attribute:
514 </p>
515 </li>
516 </ul></div>
517 <div class="listingblock">
518 <div class="content">
519 <pre><tt>$ git check-attr diff org/example/MyClass.java
520 org/example/MyClass.java: diff: java</tt></pre>
521 </div></div>
522 <div class="ulist"><ul>
523 <li>
525 Listing multiple attributes for a file:
526 </p>
527 </li>
528 </ul></div>
529 <div class="listingblock">
530 <div class="content">
531 <pre><tt>$ git check-attr crlf diff myAttr -- org/example/MyClass.java
532 org/example/MyClass.java: crlf: unset
533 org/example/MyClass.java: diff: java
534 org/example/MyClass.java: myAttr: set</tt></pre>
535 </div></div>
536 <div class="ulist"><ul>
537 <li>
539 Listing an attribute for multiple files:
540 </p>
541 </li>
542 </ul></div>
543 <div class="listingblock">
544 <div class="content">
545 <pre><tt>$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
546 org/example/MyClass.java: myAttr: set
547 org/example/NoMyAttr.java: myAttr: unspecified</tt></pre>
548 </div></div>
549 <div class="ulist"><ul>
550 <li>
552 Not all values are equally unambiguous:
553 </p>
554 </li>
555 </ul></div>
556 <div class="listingblock">
557 <div class="content">
558 <pre><tt>$ git check-attr caveat README
559 README: caveat: unspecified</tt></pre>
560 </div></div>
561 </div>
562 <h2 id="_see_also">SEE ALSO</h2>
563 <div class="sectionbody">
564 <div class="paragraph"><p><a href="gitattributes.html">gitattributes(5)</a>.</p></div>
565 </div>
566 <h2 id="_git">GIT</h2>
567 <div class="sectionbody">
568 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
569 </div>
570 <div id="footer">
571 <div id="footer-text">
572 Last updated 2011-03-15 23:30:13 UTC
573 </div>
574 </div>
575 </body>
576 </html>