git-check-attr(1): add output and example sections
[git/dscho.git] / Documentation / git-check-attr.txt
blob4b3c2b0b06e9821124759d0cc6240d0a1953d2fa
1 git-check-attr(1)
2 =================
4 NAME
5 ----
6 git-check-attr - Display gitattributes information.
9 SYNOPSIS
10 --------
11 'git check-attr' attr... [--] pathname...
13 DESCRIPTION
14 -----------
15 For every pathname, this command will list if each attr is 'unspecified',
16 'set', or 'unset' as a gitattribute on that pathname.
18 OPTIONS
19 -------
20 \--::
21         Interpret all preceding arguments as attributes, and all following
22         arguments as path names. If not supplied, only the first argument will
23         be treated as an attribute.
25 OUTPUT
26 ------
28 The output is of the form:
29 <path> COLON SP <attribute> COLON SP <info> LF
31 Where <path> is the path of a file being queried, <attribute> is an attribute
32 being queried and <info> can be either:
34 'unspecified';; when the attribute is not defined for the path.
35 'unset';;       when the attribute is defined to false.
36 'set';;         when the attribute is defined to true.
37 <value>;;       when a value has been assigned to the attribute.
39 EXAMPLES
40 --------
42 In the examples, the following '.gitattributes' file is used:
43 ---------------
44 *.java diff=java -crlf myAttr
45 NoMyAttr.java !myAttr
46 README caveat=unspecified
47 ---------------
49 * Listing a single attribute:
50 ---------------
51 $ git check-attr diff org/example/MyClass.java
52 org/example/MyClass.java: diff: java
53 ---------------
55 * Listing multiple attributes for a file:
56 ---------------
57 $ git check-attr crlf diff myAttr -- org/example/MyClass.java
58 org/example/MyClass.java: crlf: unset
59 org/example/MyClass.java: diff: java
60 org/example/MyClass.java: myAttr: set
61 ---------------
63 * Listing attribute for multiple files:
64 ---------------
65 $ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
66 org/example/MyClass.java: myAttr: set
67 org/example/NoMyAttr.java: myAttr: unspecified
68 ---------------
70 * Not all values are equally unambiguous:
71 ---------------
72 $ git check-attr caveat README
73 README: caveat: unspecified
74 ---------------
76 SEE ALSO
77 --------
78 linkgit:gitattributes[5].
81 Author
82 ------
83 Written by Junio C Hamano <gitster@pobox.com>
85 Documentation
86 --------------
87 Documentation by James Bowes.
89 GIT
90 ---
91 Part of the linkgit:git[1] suite