]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-check-attr.txt
GIT 1.6.2-rc0
[thirdparty/git.git] / Documentation / git-check-attr.txt
CommitLineData
b568a503
JB
1git-check-attr(1)
2=================
3
4NAME
5----
0d641f75 6git-check-attr - Display gitattributes information
b568a503
JB
7
8
9SYNOPSIS
10--------
e7108fcb 11[verse]
b1889c36 12'git check-attr' attr... [--] pathname...
e7108fcb 13'git check-attr' --stdin [-z] attr... < <list-of-paths>
b568a503
JB
14
15DESCRIPTION
16-----------
17For every pathname, this command will list if each attr is 'unspecified',
18'set', or 'unset' as a gitattribute on that pathname.
19
20OPTIONS
21-------
b4666852
DP
22--stdin::
23 Read file names from stdin instead of from the command-line.
24
25-z::
26 Only meaningful with `--stdin`; paths are separated with
27 NUL character instead of LF.
28
b568a503
JB
29\--::
30 Interpret all preceding arguments as attributes, and all following
31 arguments as path names. If not supplied, only the first argument will
32 be treated as an attribute.
33
5782566d
JF
34OUTPUT
35------
36
37The output is of the form:
38<path> COLON SP <attribute> COLON SP <info> LF
39
40Where <path> is the path of a file being queried, <attribute> is an attribute
41being queried and <info> can be either:
42
43'unspecified';; when the attribute is not defined for the path.
44'unset';; when the attribute is defined to false.
45'set';; when the attribute is defined to true.
46<value>;; when a value has been assigned to the attribute.
47
48EXAMPLES
49--------
50
51In the examples, the following '.gitattributes' file is used:
52---------------
53*.java diff=java -crlf myAttr
54NoMyAttr.java !myAttr
55README caveat=unspecified
56---------------
57
58* Listing a single attribute:
59---------------
60$ git check-attr diff org/example/MyClass.java
61org/example/MyClass.java: diff: java
62---------------
63
64* Listing multiple attributes for a file:
65---------------
66$ git check-attr crlf diff myAttr -- org/example/MyClass.java
67org/example/MyClass.java: crlf: unset
68org/example/MyClass.java: diff: java
69org/example/MyClass.java: myAttr: set
70---------------
71
72* Listing attribute for multiple files:
73---------------
74$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
75org/example/MyClass.java: myAttr: set
76org/example/NoMyAttr.java: myAttr: unspecified
77---------------
78
79* Not all values are equally unambiguous:
80---------------
81$ git check-attr caveat README
82README: caveat: unspecified
83---------------
b568a503 84
0e545f75
JH
85SEE ALSO
86--------
5162e697 87linkgit:gitattributes[5].
0e545f75
JH
88
89
b568a503
JB
90Author
91------
59eb68aa 92Written by Junio C Hamano <gitster@pobox.com>
b568a503
JB
93
94Documentation
95--------------
96Documentation by James Bowes.
97
98GIT
99---
9e1f0a85 100Part of the linkgit:git[1] suite